aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..305d5b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,6 @@
+This is a skeleton project for building NES roms using WLA-DX. You should be
+able to set the project name in the Makefile, add your code to main.s, and
+then build using `make`. If you have fceux installed, `make run` will build
+the project and then load the rom into fceux for testing. I've tried to
+document as much as possible in comments, but feedback is very much welcome
+about things that are unclear.