aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesse Luehrs <doy@tozt.net>2014-10-06 03:27:38 -0400
committerJesse Luehrs <doy@tozt.net>2014-10-06 03:27:38 -0400
commit5953d15e8ae15359b681a7721af41a46c54e60be (patch)
treeedd828fde1f54274d711680742376eb7bd01b8eb
parentfd6950b364ceb0f9f6e1516d1dbe460e5d2a0bf3 (diff)
downloadnes-project-skeleton-5953d15e8ae15359b681a7721af41a46c54e60be.tar.gz
nes-project-skeleton-5953d15e8ae15359b681a7721af41a46c54e60be.zip
add readme
-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.