summaryrefslogtreecommitdiff
path: root/readme.txt
diff options
context:
space:
mode:
authorJustin Worthe <justin.worthe@gmail.com>2017-05-30 21:28:32 +0200
committerJustin Worthe <justin.worthe@gmail.com>2017-05-30 21:28:32 +0200
commit29181fce4797b6e4833ab56d1fa7ff9fa865965b (patch)
treeba4860771b048d99bd3164c908bf19291378ccea /readme.txt
parentf9fc98d0091ec72d639f1fdb4cce1ef25f7eea05 (diff)
Added readme to project
Diffstat (limited to 'readme.txt')
-rw-r--r--readme.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/readme.txt b/readme.txt
new file mode 100644
index 0000000..ffffa2f
--- /dev/null
+++ b/readme.txt
@@ -0,0 +1,20 @@
+* Admiral Worthebot
+
+** Compilation Instructions
+
+As per the Rust sample bot. Install the Rust build toolchain from https://www.rust-lang.org/en-US/install.html, then from the root directory of the project run
+
+cargo build --release
+
+** Project Structure
+
+Cargo.toml - Cargo project config, including project dependencies
+src/ - Soure code directory
+src/main.rs - Command line entrypoint (main function) and command line argument parsing
+src/lib.rs - Programs public interface (as used by main.rs and any integration tests)
+
+** Strategy
+
+- Track all possible ways that an opponent may have placed their ships
+- After every move, deduce which possibilities are now impossible
+- Shoot in an attempt to (possibly) eliminate as many possibilities as possible