Add readme info for partial docs

This commit is contained in:
Joey Yakimowich-Payne 2018-06-19 21:02:00 +09:00
commit e9da3510d9

View file

@ -1,2 +1,16 @@
# nim-libnx
Libnx ported to the Nim programming language
Libnx ported to the Nim programming language. You will need a nim compiler with Nintendo switch support which can be found [here](https://github.com/jyapayne/Nim/tree/nintendo_switch_support) until the PR is accepted.
Simply run
```bash
nimble install
```
and then cd into the examples folder and compile an example:
```bash
nim build <example_name>
```
PRs are welcome for porting other examples or any other changes!