Skip to content

Commit eab6755

Browse files
committed
readme, license and gitignore
1 parent f0c2eab commit eab6755

File tree

3 files changed

+94
-2
lines changed

3 files changed

+94
-2
lines changed

.gitignore

+60-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,62 @@
1+
# Created by https://www.gitignore.io/api/rust,linux,macos
2+
3+
### Linux ###
4+
*~
5+
6+
# temporary files which can be created if a process still has a handle open of a deleted file
7+
.fuse_hidden*
8+
9+
# KDE directory preferences
10+
.directory
11+
12+
# Linux trash folder which might appear on any partition or disk
13+
.Trash-*
14+
15+
# .nfs files are created when an open file is removed but is still being accessed
16+
.nfs*
17+
18+
### macOS ###
19+
*.DS_Store
20+
.AppleDouble
21+
.LSOverride
22+
23+
# Icon must end with two \r
24+
Icon
25+
26+
# Thumbnails
27+
._*
28+
29+
# Files that might appear in the root of a volume
30+
.DocumentRevisions-V100
31+
.fseventsd
32+
.Spotlight-V100
33+
.TemporaryItems
34+
.Trashes
35+
.VolumeIcon.icns
36+
.com.apple.timemachine.donotpresent
37+
38+
# Directories potentially created on remote AFP share
39+
.AppleDB
40+
.AppleDesktop
41+
Network Trash Folder
42+
Temporary Items
43+
.apdisk
44+
45+
### Rust ###
46+
# Generated by Cargo
47+
# will have compiled files and executables
48+
/target/
49+
50+
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
51+
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
52+
Cargo.lock
53+
54+
# These are backup files generated by rustfmt
55+
**/*.rs.bk
56+
57+
58+
# End of https://www.gitignore.io/api/rust,linux,macos
59+
60+
# Make
161
build
262
out
3-
target
4-
Cargo.lock

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2018 Igor Borges
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<h1 align="center">
2+
<img src="https://user-images.githubusercontent.com/735858/40282489-8b1954b6-5c46-11e8-8a37-edc3f6f3ffeb.png" height="300"/>
3+
<br/>
4+
Rusted Switch
5+
</h1>
6+
7+
## How
8+
This project uses [rust-bindgen](https://github.com/rust-lang-nursery/rust-bindgen) to create bindings for [libnx](https://github.com/switchbrew/libnx).
9+
10+
For some reason, I couldn't use Makefile to compile Rust, so that's why this `makew` file exists. Also, direct compilation from Rust to elf didn't find `_start` function to run the code, that's why there's a C -> Rust (-> C) architecture.
11+
12+
## Credits
13+
- [rpi3-rust-template](https://github.com/cs140e/rpi3-rust-template) on building for aarch64-none-elf.

0 commit comments

Comments
 (0)