Merge branch 'master' of github.com:smparsons/lazy-chip8

smparsons · Sep 15, 2018 · e4cf263 · e4cf263
2 parents b8d98c0 + ed0f34d
commit e4cf263
Showing 1 changed file with 14 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
 
 This is my CHIP-8 emulator written in Haskell. Since I've become interested in emulation, I decided a CHIP-8 emulator would be a good starting project. I also used this project to teach myself Haskell, and to get used to a TDD approch to software development.
 
-While developing this project, I used <a href="http://www.multigesture.net/articles/how-to-write-an-emulator-chip-8-interpreter/">this tutorial</a> to help me understand the basics of building a CHIP-8 emulator. I also used <a href="https://en.wikipedia.org/wiki/CHIP-8">this wikipedia page</a> which contains helpful documentation on each CHIP-8 opcode.
+While developing this project, I used <a href="http://www.multigesture.net/articles/how-to-write-an-emulator-chip-8-interpreter/" target="_blank">this tutorial</a> to help me understand the basics of building a CHIP-8 emulator. I also used <a href="https://en.wikipedia.org/wiki/CHIP-8" target="_blank">this wikipedia page</a> which contains helpful documentation on each CHIP-8 opcode.
 
 ## How to Run
 
-You will need to have Stack setup first before you can run this project. Read <a href="https://docs.haskellstack.org/en/stable/README/">this documentation</a> to learn how to setup Stack.
+You will need to have Stack setup first before you can run this project. Read <a href="https://docs.haskellstack.org/en/stable/README/" target="_blank">this documentation</a> to learn how to setup Stack.
 
 Note that this project has been developed and tested in Linux. I have not tested this project in either the Windows or Mac operating systems. 
 
@@ -22,7 +22,7 @@ You can then easily run the emulator from any directory:
 $ lazy-chip8 "the/path/to/your/rom"
 ```
 
-### Running During Development
+### Running during Development
 
 While developing locally, you can build and run the executable using the following stack commands:
 ```
@@ -45,3 +45,14 @@ $ stack test
   <img src="screenshots/GUESS.png" width="400" />  
   <img src="screenshots/INVADERS.png" width="400" />
 </p>
+
+## Possible Future Enhancements 
+
+<ol>
+  <li>Add some validation when we load ROMs that will check to make sure the ROM isn't too big to fit into memory.</li>
+  <li>Try testing this emulator on Mac and Windows operating systems and document the steps needed to install it.</li>
+  <li>Implement a config setting that allows you to toggle whether graphics should wrap around to the other side of the screen when drawing near the edge of it. This could be set using a command line argument. Currently the emulator always wraps and there's no way to turn it off.</li>
+  <li>Implement two config settings that will toggle the load store quirk and shift quirk as documented <a href="https://github.com/tomdaley92/Kiwi8/issues/9" target="_blank">here</a>. These could be set using command line arguments.</li>
+  <li>Implement Super Chip opcodes.</li>
+  <li>Make it easier to load games so you don't necessarily have to do it through the comamnd line. Maybe a file menu that allows you to pick from a selection of games?</li>
+</ol>