Merge pull request #125 from HaliteChallenge/doc-tweaks

Add documentation for hlt_client

Author: whatelsie

tools/hlt_client/README.md

@@ -0,0 +1,56 @@
+# Halite Client
+
+## Installation
+Download the tool from our [downloads page](https://halite.io/learn-programming-challenge/downloads). Run `python setup.py install` to install the client.
+
+* If you have multiple Python installations, make sure to install using Python 3. You may also need to invoke `hlt` commands with `python3 -m hlt_client` if `hlt` throws errors.
+* You may have to `sudo` or use an admin shell.
+
+## Usage
+The Halite Client lets you interface with our game servers and play games locally using the command line.
+
+**Authorize your client**
+
+Before you can use most features of the client, you'll need to connect it to your Halite account. Have your Halite API key ready, or generate a new one at https://halite.io/user/settings.
+
+`hlt auth`
+
+
+**Upload a bot**
+
+Uploads the specified bot onto the Halite game servers.
+
+`hlt bot -b [PATH_TO_ZIP] upload`
+
+
+**Download current bot**
+
+Downloads your currently-playing bot into a zip archive.
+
+`hlt bot -b [NAME].zip download`
+
+
+**Run any number of games**
+
+This command runs the number of games you specify, creating save logs and replays as normal, and tells you the win ratio as games are played.
+
+`hlt play -r [BOT_COMMAND] -r [BOT_COMMAND] -b [PATH_TO_HALITE.EXE] --output-dir [OUTPUT_LOCATION] -i [NUMBER_OF_ITERATIONS]`
+
+* You may give two or four `-r [BOT_COMMAND]` parameters to run two or four player games.
+* `[BOT_COMMAND]` allows you to specify how to run a bot. The command defaults to Python 3; if only a path is given, the client will run the bot assuming it is a Python bot. You may also mix and match: `hlt play -r "python3 Halite3_Py/MyBot.py" -r "ruby Halite3_Ruby/MyBot.rb" ...` allows you to compare bots in different languages.
+* The halite.exe game binary is required to play games. Specify the path after the -b (--binary) parameter: `-b Halite3_Py/halite`
+* If you'd like to specify the game map size, you can add `-W [WIDTH] -H [HEIGHT]` parameters. Game maps are 32x32, 40x40, 48x48, 56x56, or 64x64 in width and height.
+
+
+**Download replays**
+
+  * By user: `hlt replay user -i [USER_ID] -l [NUMBER_OF_FILES_WANTED] -d [DOWNLOAD_LOCATION]`
+    This command will download .hlt replay files of a user by id.
+
+  * By date: `hlt replay date -t [DATE] -d [DOWNLOAD_LOCATION]`
+
+    This command will download .hlt replay files of all gold ranked games on the given date. The date format is eight numbers YYYYMMDD.
+
+    Adding the `-a` flag will include silver replays as well.
+
+Adding the `--decompress` flag to the end of any replay download command will download .json instead of .hlt replay files.

website/learn-programming-challenge/contributing.md

@@ -63,12 +63,10 @@ Each turn, every bot is sent:
   * A list of this player’s dropoffs.
 3. The changed cells on the game map, represented by an update count (how many cells have changed) and the details of changed cells (x, y, halite amount).
 
-Some objects are recreated from scratch each turn, such as ships. Other objects are reused and updated each turn, such as the the map and player. It’s helpful to be clear when writing your starter kit which objects are recreated and which are reused from turn to turn.
-
 
 <br/>
 ### Submitting your new starter kit
-To submit your starter kit, fork our repo, place your starter package in the `starter-kits/` folder, and send us a pull request! If we accept your PR, your starter package will be added to the site.
+To submit your starter kit, fork our repo, place your starter package in the `starter-kits/` folder, and send us a pull request! The Halite repo is licensed under the MIT License; please ensure that your code does not include copyright language. If we accept your PR, your starter package will be added to the site.
 
 
 **Note:** please include the `run_game.sh` and `run_game.bat` scripts, following the Python3 starter kit as a template.

website/learn-programming-challenge/downloads.md

@@ -9,12 +9,11 @@ sort_key: 3
 
 <div class="doc-section" markdown="1">
 
-Download a language-specific starter kit to start building your bot. Can’t find your preferred language? We love contributions! Check out our [contribution guide](/learn-programming-challenge/contributing).
-
 
----
 
 ## STARTER KITS DOWNLOAD
+Download a language-specific starter kit to start building your bot. Can’t find your preferred language? We love contributions! Check out our [contribution guide](/learn-programming-challenge/contributing).
+
 
 <div class="table-container">
     <table class="table">
@@ -55,6 +54,8 @@ Download a language-specific starter kit to start building your bot. Can’t fin
 </div>
 <br>
 ## Halite Tools and Source Download
+Download tools to play games locally. Read the CLI Client Tools README included in the download for installation and usage instructions.
+
 
 <div class="table-container">
     <table class="table">