Removed deconstruction from the list of commands considered
[entelect-challenge-tower-defence.git] / README.md
1 # Rust Sample Bot
2
3 Rust is a systems programming language, giving programmers the low
4 level control that they would usually associate with a programming
5 langauge like C or C++, but modern high level programming features.
6
7 Rust is a compiled language, which compiles to an
8 architecture-specific binary.
9
10 For getting started with this bot in particular, I've done a write up
11 about [writing a Rust bot for the Entelect challenge](https://www.worthe-it.co.za/programming/2018/05/02/writing-an-entelect-challenge-bot-in-rust.html).
12
13 ## Environment Setup
14
15 The Rust compiler toolchain can be downloaded from the Rust project
16 website.
17
18 https://www.rust-lang.org/en-US/install.html
19
20 ## Compilation
21
22 The bot can be built using the Rust build tool, Cargo. For the sake of
23 the competition, the `--release` flag should be used.
24
25 ```
26 cargo build --release
27 ```
28
29 ## Running
30
31 After compilation, there will be an executable in
32 `target/release/`.
33
34 For example, this sample bot's name is
35 `entelect_challenge_rust_sample`, so the executable to be run is
36 `target/release/entelect_challenge_rust_sample` on Linux or
37 `target/release/entelect_challenge_rust_sample.exe` on Windows.
38