From e9da3510d9828f3f16a323858a99fc793f988d3f Mon Sep 17 00:00:00 2001
From: Joey Yakimowich-Payne <jyapayne@gmail.com>
Date: Tue, 19 Jun 2018 21:02:00 +0900
Subject: [PATCH] Add readme info for partial docs

---
 README.md | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

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 <example_name>
+```
+
+PRs are welcome for porting other examples or any other changes!