docs

README.md

@@ -1,3 +1,58 @@
+# Space Trading
+
+**Space Trading** is a computerized board game intended to be played together in a room with family or friends. The "game board" is displayed by the server on the big TV, and each player has their laptop running the client to control the character.
+
+The goal is to pay off your ship's mortgage first.
+
+# How To Play
+
+*This project uses [GCC](https://gcc.gnu.org/) to build. Make sure you have that installed locally first.*
+
+On every computer that you will need to play, download this repository:
+```
+git clone git@github.com:Tenari/space-trading.git
+cd space-trading
+```
+and then build it:
+
+MacOSX/unix:
+```bash
+./make.sh server
+
+or
+
+./make.sh client
+```
+
+Windows (client only):
+```bash
+./win_make.bat
+```
+
+The resulting executable binary file will be in the `build` directory. Run it from the unix command line:
+```bash
+./build/server
+
+or
+
+./build/client
+```
+
+Or, double-click on the windows .exe file.
+
+---
+
+All computers you will use to play must be connected to the same Wi-Fi network. It uses Local Area Networking (LAN) to connect them together.
+
+1. connect a computer to your main TV/projector screen. This will be your "server." Run the server binary
+2. you can press `TAB` on the server to switch between Debug and Map. Map is the main game-view.
+3. have each player run their `client` application. It will prompt them for the `Server IP Address`, which should be displayed in the top right corner of the server.
+4. Don't bother with secure passwords when logging. The password is just to prevent your brother from trying to login as you.
+5. Wait until each player has selected their ship and sees the "Map" tab on their screen.
+6. Start playing!
+
+### ideas
+
 space-trader-multiplayer-boardgame-esque:
 
 - projector shows the star-map with everyone's positions