From 234b9c53575d65530a1a1e68166a5370cdb6dca2 Mon Sep 17 00:00:00 2001
From: Meziu <55318903+Meziu@users.noreply.github.com>
Date: Fri, 29 Oct 2021 12:36:58 +0200
Subject: [PATCH] Create README.md

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c30be82
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# cargo-3ds
+Cargo command to work with Nintendo 3DS project binaries. Based on cargo-psp.
+
+# Usage
+While you can set the nightly version of Rust as default for the project you're working on (`rustup override nightly`), my suggested method is:
+`cargo +nightly 3ds`. \
+The commands are `build` and `link` (link also assures a build exists before running, so you can directly use `link` to compile and run).
+
+# Examples: 
+`cargo +nightly 3ds build` \
+`cargo +nightly 3ds link --release`
+
+You can pass or not `--release` to build with debug symbols or not, and this works for both `build` and `link`.
+
+Any other parameters you pass after the command (being it `build` or `link`) will be passed during the compiling stage to `cargo`.