aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2016-12-11 11:02:56 +0100
committerClifford Wolf <clifford@clifford.at>2016-12-11 11:02:56 +0100
commit71c47f13ed15d4635a408832d69f0cfb6b35443e (patch)
tree15e98a55092bd2270f34f1083bc1fbc16f515202
parent5c96982522779fef5b63bcc16297e6633dafff03 (diff)
downloadyosys-71c47f13ed15d4635a408832d69f0cfb6b35443e.tar.gz
yosys-71c47f13ed15d4635a408832d69f0cfb6b35443e.tar.bz2
yosys-71c47f13ed15d4635a408832d69f0cfb6b35443e.zip
Some minor CodingReadme changes in unit test section
-rw-r--r--CodingReadme14
1 files changed, 4 insertions, 10 deletions
diff --git a/CodingReadme b/CodingReadme
index 041f3b1fa..9e85add28 100644
--- a/CodingReadme
+++ b/CodingReadme
@@ -429,7 +429,7 @@ well with C/C++ code. Hence, it was chosen (google test)
relatively easy learn.
Install and configure google test (manually)
-============================================
+--------------------------------------------
In this section, you will see a brief description of how to install google
test. However, it is strongly recommended that you take a look to the official
@@ -456,7 +456,7 @@ Ps.: Some distros already have googletest packed. If your distro supports it,
you can use it instead of compile.
Create new unit test
-=======================
+--------------------
If you want to add new unit tests for Yosys, just follow the steps below:
@@ -467,19 +467,13 @@ If you want to add new unit tests for Yosys, just follow the steps below:
unit test for kernel/celledges.cc, you will need to create a file like this:
tests/unit/kernel/celledgesTest.cc;
* Implement your unit test
-* If you want to compile your tests, just go to yosys root directory and type:
-```
-make unit-test
-```
Run unit test
-=============
+-------------
-To run all unit tests, you need to compile it first and then run it. Follow the
-steps below (from the yosys root directory):
+To compile and run all unit tests, just go to yosys root directory and type:
```
make unit-test
-make run-all-unitest
```
If you want to remove all unit test files, type: