Added quickstart.

bh107 · Apr 2, 2015 · 257423e · 257423e
1 parent b3628dc
commit 257423e
Show file tree

Hide file tree

Showing 5 changed files with 53 additions and 31 deletions.
diff --git a/README.rst b/README.rst
@@ -6,27 +6,5 @@ Read the full
 
 on Benchpress or see below for a quick start.
 
-Quick Start
-===========
-
-Fire up your terminal, and::
-
-  # Clone the repos
-  git clone git@github.com:bh107/benchpress.git
-
-  # Enter the root
-  cd benchpress
-
-  # Source environment vars
-  source util/setbpenv.bash
-
-You now have the Benchpress commands, ``bp_run``, ``bp_times``, ``bp_info``, ``bp_compile``, and ``bp_grapher`` ready at your finger-tips along with all the benchmarks and suites.
-
-Go ahead and run the `numpy_only` suite, executing each benchmark in the suite twice::
-
-  bp_run --no-perf --no-time --runs 2 --output my_run.json suites/numpy_only.py
-
-The above will store results from the run in the file `my_run.json`. You can inspect the elapsed wall-clock by executing::
-
-  bp_times my_run.json
+.. include:: doc/source/quickstart.rst
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -7,6 +7,7 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
+   quickstart
    install
    tools
    benchmarks

diff --git a/doc/source/install.rst b/doc/source/install.rst
@@ -6,7 +6,7 @@ Benchpress is distributed via PyPi and Github. Which means that you can install
 The installation method of choice is based on what you want to do with Benchpress. Recommendations are as follows.
 
  * Install Benchpress as a Python packages from PyPi if your sole intent is to `run` benchmarks.
- * Use benchpress directly from clone/tarball if you intend to modify it. Such as adding benchmarks, changing commands or benchmark suites.
+ * Use Benchpress directly from clone/tarball if you intend to modify it. Such as adding benchmarks, changing commands or benchmark suites.
 
 .. note:: Benchpress is designed to work, with minimal friction, in an environment where the user has limited system permissions. Such as shared computing environments, clusters and supercomputers. A system-wide installation of Benchpress is therefore untested. However, it should work if write permission is assigned to Benchpress users for the ``benchmarks`` folder.
 

diff --git a/doc/source/quickstart.rst b/doc/source/quickstart.rst
@@ -0,0 +1,24 @@
+Quick Start
+===========
+
+Fire up your terminal, and::
+
+  # Clone the repos
+  git clone git@github.com:bh107/benchpress.git
+
+  # Enter the root
+  cd benchpress
+
+  # Source environment vars
+  source util/setbpenv.bash
+
+You now have the Benchpress commands, ``bp_run``, ``bp_times``, ``bp_info``, ``bp_compile``, and ``bp_grapher`` ready at your finger-tips along with all the benchmarks and suites.
+
+Go ahead and run the `numpy_only` suite, executing each benchmark in the suite twice::
+
+  bp_run --no-perf --no-time --runs 2 --output my_run.json suites/numpy_only.py
+
+The above will store results from the run in the file `my_run.json`. You can inspect the elapsed wall-clock by executing::
+
+  bp_times my_run.json
+
diff --git a/doc/source/tools.rst b/doc/source/tools.rst
@@ -1,7 +1,17 @@
 =====
-Usage
+Using
 =====
 
+bp_info
+-------
+
+...
+
+bp_compile
+----------
+
+...
+
 bp_run
 ------
 
@@ -17,20 +27,29 @@ bp_grapher
 
 ...
 
-Implementations / Libraries / Modules
-=====================================
+======================
+Extending and Changing
+======================
+
+Benchmark Protocol and conventions
+----------------------------------
+
+...
 
 Python
 ------
 
 ...
 
-C / C++
--------
+C
+--
+
+...
+
+C++
+---
 
 ...
 
-Protocol
-========
 
 ...