diff --git a/README.rst b/README.rst index 9ade173..cda70ed 100644 --- a/README.rst +++ b/README.rst @@ -6,8 +6,8 @@ Open Source Architecture Code Analyzer This tool allows automatic instruction fetching of assembly code, auto-generating of testcases for assembly instructions creating latency -and throughput benchmarks on a specific instruction form and thorughput -analysis and throughput prediction for a inner-most loop code snippet. +and throughput benchmarks on a specific instruction form and throughput +analysis and throughput prediction for a innermost loop kernel. .. image:: https://travis-ci.com/RRZE-HPC/OSACA.svg?token=393L6z2HEXNiGLtZ43s6&branch=master :target: https://travis-ci.com/RRZE-HPC/OSACA @@ -21,27 +21,59 @@ Getting started Installation ~~~~~~~~~~~~ -On most systems with python pip and setuputils installed, just run: -:: +.. On most systems with python pip and setuputils installed, just run: +.. :: pip install --user osaca -for the latest release. -If you want to build from source, clone this repository using ``git clone https://github.com/RRZE-HPC/OSACA`` and run in the root directory: +.. for the latest release. +To build OSACA from source, clone this repository using ``git clone https://github.com/RRZE-HPC/OSACA`` and run in the root directory: :: python ./setup.py install -*Dependencies:* +After installation, OSACA can be started with the command ``osaca`` in the CLI. + +Dependencies: ~~~~~~~~~~~~~~~ Additional requirements are: -- `Python `__ 3.5.2 or higher -- `pandas `__ 0.18.1 or higher -- `NumPy `__ 1.11.1 or higher -- `kerncraft `__ 0.4.11 or - higher +- `Python3 ` +- `pandas ` +- `NumPy ` +- `Kerncraft ` +- `ibench ` marker in suggested assembly blocks. +- ``FILEPATH`` describes the filepath to the file to work with and is always necessary + +Hereinafter the main tasks will be described. + +Throughput analysis +~~~~~~~~~~~~~~~~~~~ +Lorem ipsum + +Include new measurements into the data file +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Lorem ipsum + +Insert IACA markers +~~~~~~~~~~~~~~~~~~~ +Lorem ipsum + Credits =======