diff --git a/README.md b/README.md index c3687aa..10e9e06 100644 --- a/README.md +++ b/README.md @@ -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 +``` + +PRs are welcome for porting other examples or any other changes!