Update README.md for end-of-term release (#200)

* Update README.md * Update note * Update readthedocs.io index Closes #138.
PDXCapstoneF · Jun 17, 2018 · 2de3871 · 2de3871
1 parent 41f3588
commit 2de3871
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -22,6 +22,9 @@ SPECtate is a configuration tool that interfaces with the benchmarking software
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage for notes on how to use the project on a live system.
 
+There's a pre-packaged binary for quick, out-of-the box setup without **any dependencies**! 
+Check out the [releases](https://github.com/PDXCapstoneF/SPECtate/releases) for binaries for the main CLI application.
+
 ### Prerequisites
 
 * UNIX (Linux, Mac OSX), or Windows

diff --git a/docs/index.md b/docs/index.md
@@ -22,6 +22,9 @@ SPECtate is a configuration tool that interfaces with the benchmarking software
 
 These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage for notes on how to use the project on a live system.
 
+There's a pre-packaged binary for quick, out-of-the box setup without **any dependencies**! 
+Check out the [releases](https://github.com/PDXCapstoneF/SPECtate/releases) for binaries for the main CLI application.
+
 ### Prerequisites
 
 * UNIX (Linux, Mac OSX), or Windows
@@ -45,6 +48,21 @@ pipenv install
 ```
 
 
+#### Docker
+
+This project has a Docker file. You can build an image 
+yourself and run SPECtate with it:
+
+```shell
+# build the image
+docker build -t SPECtate:latest .
+# run SPECtate
+docker run SPECtate:latest --help
+# would display the help text like you ran it yourself
+# with python mainCLI.py --help
+```
+
+
 ## Example CLI Usage
 
 * Run an example configuration: