Merge pull request #747 from mithro/master

README: Converting to numbered lists

README.md

@@ -57,34 +57,34 @@ Finally the file containing the test case and metadata should be placed in `test
 
 ## Importing existing tests from a test suite/core/tool
 
-* Add the tests as a submodule to this repository via `git submodule add <git_url> third_party/<category>/<name>`.
-  If you want to add tests from a tool that is already in `third_party/tools` you can skip this step.
-* Add a new tag named `<name>` to `conf/lrm.conf` together with a short description.
-* Generate wrapper `.sv` files by either:
-  * Adding a new config to `conf/generators/meta-path/` that will be used by `generators/path_generator`.
-  * Adding a new generator script to `generators/` that will create required wrappers.
+1. Add the tests as a submodule to this repository via `git submodule add <git_url> third_party/<category>/<name>`.
+   If you want to add tests from a tool that is already in `third_party/tools` you can skip this step.
+2. Add a new tag named `<name>` to `conf/lrm.conf` together with a short description.
+3. Generate wrapper `.sv` files by either:
+   * Adding a new config to `conf/generators/meta-path/` that will be used by `generators/path_generator`.
+   * Adding a new generator script to `generators/` that will create required wrappers.
 
-  First method works well with test suites in which each test case is contained in a separate Verilog file.
-  If the test suite provides metadata that must be processed or you are importing an IP core then you should create custom generator script.
+   First method works well with test suites in which each test case is contained in a separate Verilog file.
+   If the test suite provides metadata that must be processed or you are importing an IP core then you should create custom generator script.
 
-  Use tag that you added in the previous step.
+   Use tag that you added in the previous step.
 
 ## Adding a new tool
 
-* Make the tool available from [Anaconda](https://anaconda.org/) by either:
-  * Adding the tool to the [SymbiFlow/conda-packages](https://github.com/SymbiFlow/conda-packages) repository.
-  * Adding the tool to any other `conda` channel.
+1. Make the tool available from [Anaconda](https://anaconda.org/) by either:
+   * Adding the tool to the [SymbiFlow/conda-packages](https://github.com/SymbiFlow/conda-packages) repository.
+   * Adding the tool to any other `conda` channel.
 
-  If the tool is already available as a `conda` package you can skip this step.
-* Add the conda package as a dependency in `conf/environment.yml`.
-* Add the tool as a submodule to this repository via `git submodule add <git_url> third_party/tools/<name>`.
-* Add a target for building and installing the tool manually in `tools/runners.mk`
-* Create a new runner script in `tools/runners/<name>.py` that will contain a subclass of `BaseRunner` named `<name>`.
-  This subclass will need to at least implement the following methods:
-  * `__init__` to provide general information about the tool.
-  * `prepare_run_cb` to prepare correct tool invocation that will be used during tests.
+   If the tool is already available as a `conda` package you can skip this step.
+2. Add the conda package as a dependency in `conf/environment.yml`.
+3. Add the tool as a submodule to this repository via `git submodule add <git_url> third_party/tools/<name>`.
+4. Add a target for building and installing the tool manually in `tools/runners.mk`
+5. Create a new runner script in `tools/runners/<name>.py` that will contain a subclass of `BaseRunner` named `<name>`.
+   This subclass will need to at least implement the following methods:
+   * `__init__` to provide general information about the tool.
+   * `prepare_run_cb` to prepare correct tool invocation that will be used during tests.
 
-  If the new tool is a Python library, reimplement `run` and other supporting methods instead of implementing `prepare_run_cb`.
+   If the new tool is a Python library, reimplement `run` and other supporting methods instead of implementing `prepare_run_cb`.
 
 ## Supported tools