windows 64-bit build

1 files changed, 27 insertions, 20 deletions

diff --git a/README.md b/README.md
index fa6350a..f6b12c8 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,22 @@
 gamedev
 =======
 
-gamedev is a high school project between drumsetmonkey and tcsullivan written in C++ and using SDL2/OpenGL. The goal of this project is to have a completed commercial-grade video game available to Linux and Windows users. We plan on profiting off of the game once we finish it, so once the game reaches its final stages it may become closed source (however, what was uploaded will stay for others to use as a resource).
-
-NOTE!!!!
-We're always working on this project. Some commits may contain broken code, or some bugs may be undocumented. Try older commits if the latest one doesn't work.
+gamedev was started as a high school project between drumsetmonkey and tcsullivan, written in C++ and using SDL2/OpenGL. The goal of this project was to have a completed commercial-grade video game available for Linux and Windows users; the plan was to profit off the game once it and the engine were finished. Through the first year and a half of development we quickly learned that the game's engine would need the most focus, as we were starting from complete scratch. Due to this, there is no playable, plot-based game.  
+However, the engine is still growing. Development has now slowed to a crawl with the start of our college lives, but changes will still be made every now and then. Maybe a true video game will eventually come out of this, but the engine will most likely always remain open source.
 
 Build Requirements
 ------------------
 
-The 'gamedev' project can be build on both Linux-based and Windows operating systems. The game has been verified to work on Debian, Arch Linux, Fedora, FreeBSD, and Windows 7 (maybe 8 and 10, too). The following libraries are required to build 'gamedev':
+The 'gamedev' project can be built on both Linux-based and Windows operating systems. The game has been verified (at some point) to work on Debian, Arch Linux, FreeBSD, and Windows 7 through 10. The following programs and libraries are required to build 'gamedev':
 
+* make
+* g++
 * SDL2, including SDL2_image and SDL2_mixer
-* FreeType (2? libfreetype6? who knows...)
+* FreeType 2
 * GLEW
+* libgif if not on 64-bit linux
 
-Windows builds were done with MinGW. The compiler must support at least C++14.
-
-The Makefile makes calls to g++, echo and rm.
+Windows builds are done with msys2, 64-bit. The compiler must support C++17. libgif for amd64 linux is currently included in the lib/ folder, so any other build set-up must supply their own copy, and change the Makefile accordingly (see what is done for win32 builds, for example).
 
 Build Preparation
 -----------------
@@ -28,7 +27,7 @@ TARGET_OS = # either win32 or linux
 TARGET_BITS = # either 32 or 64
 ```
 
-A settings file must also exist. To take the sample one:
+A settings file must also exist. Take the sample one to start:
 ```
 (from the root directory)
 cp config/settings.xml.example config/settings.xml
@@ -41,6 +40,15 @@ mkdir out
 
 Building
 --------
+
+EntityX needs to be built only once before building the rest of gamedev, a library file will be outputted that the main Makefile uses for the main build.
+```
+cd entityx
+make
+cd ..
+```
+
+To build the engine:
 ```
 make
 ```
@@ -57,29 +65,28 @@ To run on Windows:
 main.exe
 ```
 
-The executable may take the following arguments:
+The executable takes the following arguments:
 
-* -r, which will reset XML and player data
-* -d, which will kill the game once initialization has been done
-* -x, specify which XML file to load. Looks in the XML folder, defined in config/setting.xml
+* -r, which will reset XML data and delete player data
+* -d, which will initialize the engine, and then exit
+* -x, tells the engine which XML file to load. Looks in the XML folder defined in config/setting.xml
 
--d is mainly used in conjunction with -r, to reset the XML files and then exit the game before they can be overwritten.
--x might be buggy, or not work.
+-d is mainly used in conjunction with -r, to reset the XML files and then exit the game before they can be rewritten.
 
 Controls
 --------
 
-The following are the controls for the game. Any extra controls can be found in ```src/ui.cpp```
-Controls can kinda be adjusted using the in-game control menu.
+The following are the controls for the game. Any extra controls can be found somewhere in ```src/ui.cpp``` or ```src/player.cpp```
+Some controls can be adjusted using the in-game control menu.
 
 Movement:
 * 'a' and 'd' move the player left and right
 * 'w' enters buildings
 * 'e' opens the inventory
-* 'space' make the player jump if he obtains the jumping skill
+* 'space' makes the player jump if he obtains the jumping skill
 * 'L-Shift' sprints if the player obtains the running skill
 * 'L-Ctrl' decreases the player's speed
-* 'h' opens a quest menu
+* 'h' opens a current quest menu
 
 Other:
 * 'f3' for debug information