Final Cleanup (#30)

* Remove unnecessary window reference

* Remove excessive whitespace

* Disable warnings on compile

* Add run instructions

* Add the cool README

Makefile

@@ -17,7 +17,7 @@ run: clean all
 	./$(BIN)/$(EXECUTABLE)
 
 $(BIN)/$(EXECUTABLE): $(SRC)/*.cc
-	$(CXX) $(CXX_FLAGS) -I$(INCLUDE) -L$(LIB) $^ -o $@ $(LIBRARIES)
+	$(CXX) $(CXX_FLAGS) -I$(INCLUDE) -L$(LIB) $^ -o $@ $(LIBRARIES) -w
 
 clean:
 	-rm $(BIN)/*

README.md

@@ -1,5 +1,24 @@
 # RoadRun
-*Obstacle avoidance game in C++ using object oriented design principles*
+An obstacle avoidance game in C++ using object oriented design principles.
 
-## Getting Started
-> TODO
+![](RoadRun_demo.gif)
+
+## How to Run
+Make sure [NCurses](https://invisible-island.net/ncurses/man/ncurses.3x.html) is [installed](https://www.cyberciti.biz/faq/linux-install-ncurses-library-headers-on-debian-ubuntu-centos-fedora/) with this commmand:
+```
+sudo apt-get install libncurses5-dev libncursesw5-dev
+```
+Compile and run with this command:
+```
+make run
+```
+
+## How to Play
+- Select "Play Game" to start a new game
+- Use left and right arrow keys to move your character: `^`
+- Don't hit anything!
+
+## Acknowledgements
+- SJSU's CMPE 135 Class taught by professor [Ron Mak](http://www.cs.sjsu.edu/~mak/CMPE135/index.html) for inspiration for this project.
+- All contributors
+- Everyone who helped play test

include/game.h

@@ -47,8 +47,8 @@ class Game
   int curr_high_score;
   int curr_score;
 
-  void PrintGameFrame(WINDOW *game_win);
-  void PrintInfoFrame(WINDOW *info_win);
+  void PrintGameFrame();
+  void PrintInfoFrame();
 
   void PrintPrepScreen();
   void PrintEndScreen();

include/settings_item.h

@@ -14,7 +14,6 @@ enum class SettingsItem
   kLudicrous
 };
 
-
 static const SettingsItem settings_item_list[] =
 {
   SettingsItem::kRegular,

src/game.cc

@@ -51,8 +51,8 @@ void Game::PlayGame()
 
     UpdatePlayerLoc();
 
-    PrintGameFrame(game_win);
-    PrintInfoFrame(info_win);
+    PrintGameFrame();
+    PrintInfoFrame();
     napms(1);
   }
 
@@ -68,7 +68,7 @@ void Game::PlayGame()
   endwin();
 }
 
-void Game::PrintGameFrame(WINDOW *game_win)
+void Game::PrintGameFrame()
 {  
   wclear(game_win);
 
@@ -80,7 +80,7 @@ void Game::PrintGameFrame(WINDOW *game_win)
   wrefresh(game_win);
 }
 
-void Game::PrintInfoFrame(WINDOW *info_win)
+void Game::PrintInfoFrame()
 {
   wclear(info_win);
 

src/settings_menu.cc

@@ -6,7 +6,6 @@ namespace roadrun
 {
   void SettingsMenu::RenderOptions(WINDOW *menu_win, int highlight)
   {
-
     mvwprintw(menu_win, 2, 4, "Choose a Difficulty");
     char *choices[] = { 
         "Regular Mode",