Commit 5e302f98 authored by Zixian Cai's avatar Zixian Cai

Improve documentation

parent cd38ff8b
......@@ -47,14 +47,16 @@ Installing
The framework can be *optionally* installed as a Python application.
TODO: installation instruction
::
pip install -U .
Running the tests
-----------------
To run the performance measurement locally you need to supply a YAML
file specifying the task set. An exmaple YAML task set config file can
be found at ``example/test_config.yml``. The following command runs the
To run the performance measurement locally you need to supply one or more YAML
files specifying the task sets. Exmaple YAML task set config files can
be found under ``example/``. The following command runs the
test config:
::
......@@ -67,6 +69,7 @@ Documentation
- `Task set configuration file specification <docs/config.md>`__
- `Callback and benchmark implementation
documentation <docs/callback.md>`__
- `Settings reference <docs/settings.md>`__
License
......
- `WEB_SECRET`: secret key for Flask web application
- `WEB_POI_REPO`: Repo of interest
- `WEB_POI_HOST`: Host of interest where result is produced
- `WEB_RESULT_DIR`: Paths of results on web server
- `ENVIRON`:
- `PYPY`
- `MU_HOLSTEIN`
- `MU_ZEBU`
- `ZEBU_BUILD`
- `RPYSOM`
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment