summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorStuart Stock <stuart@int08h.com>2018-09-21 21:03:06 -0500
committerStuart Stock <stuart@int08h.com>2018-09-21 21:03:09 -0500
commit363943e525d8f3448b769e92be0c0afa25e3cfbc (patch)
tree5a860c0b2ca2d041d66eeec2e66734c9a556e004 /README.md
parent213cf50250a9d13612d707fa857a177e0d9de695 (diff)
downloadroughenough-363943e525d8f3448b769e92be0c0afa25e3cfbc.zip
Document that the latest stable rust is needed to build
Reported in #7
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 56902d5..c9d44c3 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,8 @@ synchronization client and server implementation in Rust.
The server and client are functionally complete and at feature parity with the reference
C++ and Golang implementations.
-Areas for improvement remain, see [limitations](#limitations) below. Contributions are welcome.
+Requires latest stable Rust to compile. Areas for improvement remain,
+see [limitations](#limitations) below. Contributions are welcome.
## Links
* [Roughenough Github repo](https://github.com/int08h/roughenough)
@@ -21,6 +22,8 @@ Areas for improvement remain, see [limitations](#limitations) below. Contributio
## Building and Running
+Requires the latest stable Rust to build.
+
```bash
# Build roughenough
$ cargo build --release