Merge b046b1c into c094bf5

.travis.yml

@@ -20,6 +20,10 @@ script:
   --cov=revelation revelation/test/
 - python -m doctest scripts/diff_trace.py
 - python -m doctest scripts/get_instructions_used.py
+- cd docs
+- make html
+- make linkcheck
+- cd ..
 - PYTHONPATH=${HOME}/pydgin/:. ${HOME}/pypy/rpython/bin/rpython --no-pdb --opt=jit revelation/sim.py
 - if [ "${TRAVIS_PULL_REQUEST}" == "false" ] && [ "${TRAVIS_BRANCH}" == "master" ] ;
     then PYTHONPATH=${HOME}/pydgin/:. ${HOME}/pypy/rpython/bin/rpython --no-pdb --opt=jit revelation/sim.py --debug ;

README.md

@@ -112,7 +112,7 @@ If you want your compiled Revelation simulator to be able to write out a trace o
 
 Please report any problems you have with Revelation on the [Issues page](https://github.com/futurecore/revelation/issues).
 
-To contribute to Revelation itself, please raise a Pull Request, and if it is relevant to your changes please include unit tests.
+To contribute to Revelation itself, please fork this repository and raise a Pull Request, and if it is relevant to your changes please include unit tests.
 Translating Revelation will be relatively slow, so it is easiest to run and test the simulator un-translated, until your changes are stable, e.g.:
 
 ```bash
@@ -151,7 +151,7 @@ More information about this license can be found here:
   * http://choosealicense.com/licenses/bsd-3-clause
   * http://opensource.org/licenses/BSD-3-Clause
 
-Some test programs within this repository were previously published by other authors, and come with their own license agreements.
+Some test programs and benchmarks within this repository were previously published by other authors, and come with their own license agreements.
 
 
 ## Acknowledgements

docs/conf.py

@@ -54,16 +54,16 @@
 
 # General information about the project.
 project = u'Revelation'
-copyright = u'2015, Sarah Mount, Carl Friedrich Bolz'
+copyright = u'2015-2016, Sarah Mount, Carl Friedrich Bolz'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+# version = '0.1'
 # The full version, including alpha/beta/rc tags.
-release = '0.1'
+# release = '0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.