Update README

parttimenerd · Jul 11, 2019 · ca06fd2 · Kha · Jul 16, 2019 · ca06fd2
1 parent a3d8f54
commit ca06fd2
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 9 deletions.
diff --git a/README.rst b/README.rst
@@ -6,10 +6,9 @@ temci
 .. image:: https://travis-ci.org/parttimenerd/temci.svg?branch=master
     :target: https://travis-ci.org/parttimenerd/temci
 
-An advanced benchmarking tool written in python3 that supports setting up an environment for benchmarking and
- the generation of visually appealing reports.
+An advanced benchmarking tool written in python3 that supports setting up an environment for benchmarking and the generation of visually appealing reports.
 
-It runs on Linux systems and (rudimentary) on Apple's OS X systems.
+It runs on Linux systems and (rudimentary) on OS X.
 
 Why should you use temci?
 -------------------------

diff --git a/doc/index.rst b/doc/index.rst
@@ -15,6 +15,7 @@ Contents of this documentation
    temci_build
    temci_run
    temci_report
+   os_support
    resources
    changelog
    development

diff --git a/doc/installation.rst b/doc/installation.rst
@@ -5,7 +5,7 @@ This page covers the installation and updating of temci.
 System Requirements
 -------------------
 
-* Linux or Apples OS X (see `Supported Operating Systems <temci.run.html>`_)
+* Linux or OS X (see `Supported Operating Systems <temci.run.html>`_)
 * Processor with an x86 or AMD64 architecture (although most features should work on ARM too)
 
 Using Nix

diff --git a/doc/temci_run.rst → doc/temci_exec.rst b/doc/temci_run.rst → doc/temci_exec.rst
@@ -1,9 +1,50 @@
-temci run
-=========
+temci exec
+==========
 
+This page explains ``temci exec`` and ``temci short exec`` that allow you to do the actual benchmarks.
 
-Fancy Plugins
--------------
+temci short exec
+----------------
+Make basic benchmarks, without creating a configuration file. It supports the same command line options
+as ``temci exec``:
+
+.. code:: sh
+
+    Usage: temci short exec [OPTIONS] COMMANDS
+
+    -wd, --without_description COMMAND
+        Benchmark the command and use itself as its description.
+    -d, --with_description DESCRIPTION COMMAND...
+        Benchmark the command and set its description attribute.
+    …
+    (options of temci exec)
+
+Options
+-------
+For a whole list of command line options run ``temci exec --help``.
+
+Number of runs
+~~~~~~~~~~~~~~
+
+Configuration File
+------------------
+
+Runners
+-------
+The runners are selected on the command line using the ``--runner`` option and the configuration file
+via ``run/exec_misc/runner``.
+
+
+Plugins
+-------
+
+The plugins are enabled via the command line option ``--NAME_active`` and in the configuration file
+via ``run/exec_plugins/NAME_active``.
+
+Presets
+-------
+
+The following explains the different plugins.
 
 DisableCaches
 ~~~~~~~~~~~~~
@@ -46,8 +87,10 @@ interaction is disabled (by stopping X11)
 Stopping a process here means to send a process a SIGSTOP signal and
 resume it by sending a SIGCONT signal later.
 
+
+
 Error Codes
-~~~~~~~~~~~
+-----------
 
 ==== =======================================
    0 no error

diff --git a/doc/temci_report.rst b/doc/temci_report.rst
@@ -1,3 +1,18 @@
 temci report
 ============
 
+File format
+-----------
+
+Console
+-------
+
+CSV
+---
+
+HTML2
+-----
+
+
+Writing a custom reporter
+-------------------------