Merge pull request #187 from PDXCapstoneF/bs-update-docs

Update documentation for SPECtate in docs/

README.md

@@ -1,7 +1,7 @@
 | Service        | Master           | Development  |
 | ------------- |:-------------:| ------------------:|
 | CI Status      | [![Build Status](https://travis-ci.org/PDXCapstoneF/SPECtate.svg?branch=master)](https://travis-ci.org/PDXCapstoneF/SPECtate)    | [![Build Status](https://travis-ci.org/PDXCapstoneF/SPECtate.svg?branch=dev)](https://travis-ci.org/PDXCapstoneF/SPECtate) |
-
+| Documentation Status | [![Documentation Status](https://readthedocs.org/projects/spectate/badge/?version=latest)](https://spectate.readthedocs.io/en/latest/?badge=latest) | [![Documentation Status](https://readthedocs.org/projects/spectate/badge/?version=dev)](https://spectate.readthedocs.io/en/latest/?badge=dev) |
 
 # SPECtate
 
@@ -31,37 +31,50 @@ These instructions will get you a copy of the project up and running on your loc
 
 ### Setup
 
-```
-$ git clone https://github.com/PDXCapstoneF/SPECtate.git
-$ cd SPECtate/
-$ python -m unittest discover -s .
+```shell
+git clone https://github.com/PDXCapstoneF/SPECtate.git
+cd SPECtate/
+python -m unittest discover -s .
 ```
 
-This project uses `pipenv` to manage dependencies. A suggested python manager is `pyenv`.
+This project uses `pipenv` to manage dependencies. To start:
+
+```
+pipenv shell
+pipenv install
+```
 
 
 ## Example CLI Usage
 
-* Generate configurations, including run-type, java options, ... (example session)
+* Run an example configuration:
+```
+python mainCLI.py run example_config.json
+```
+
+* See what an example configuration might do:
 ```
-$ 
+python mainCLI.py run --dry-run example_config.json
 ```
 
-* Invoke SPECjbb using json/hjson/yaml file ... (example session)
+* Generate configurations:
 ```
-$ 
+# generate you own configuration via the cli in dialogue:
+python mainCLI.py dialogue
+# or through the ncurses equivalent cli:
+python speccurses.py
 ```
 
 
 ## Documentation
 
-* SPECtate documentation can be found on the project [wiki](https://github.com/PDXCapstoneF/SPECtate/wiki) page and in the Python scripts themselves. Documentation of SPECtate can be generated by using Python's standard library [pydoc](https://docs.python.org/2/library/pydoc.html).
+* SPECtate documentation can be found in [`docs/`](docs/) page and in the Python scripts themselves. Documentation of SPECtate can be generated by using Python's standard library [pydoc](https://docs.python.org/2/library/pydoc.html).
 
 Example:
 
 ```
-$ cd SPECtate/
-$ pydoc -w dialogue; open dialogue.html
+cd SPECtate/
+pydoc -w dialogue; open dialogue.html
 ```
 
 The `-w` flag in the above command will "Write out the HTML documentation for a module to a file in the current directory."
@@ -70,7 +83,7 @@ The `-w` flag in the above command will "Write out the HTML documentation for a
 
 * Unittests 
 
-* Travis-CI for Continuous integration testing during development
+* [Travis-CI](https://travis-ci.org/PDXCapstoneF/SPECtate) for Continuous integration testing during development
 
 
 ## License

docs/index.md

@@ -0,0 +1 @@
+../README.md