Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
esynr3z committed May 25, 2024
1 parent 896421d commit 6cad5ae
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Detailed documentaion can be found on https://esynr3z.github.io/sv-json[project'
* No defines
* No plusargs

IMPORTANT: The package developed and tested using Verilator 5.24 only. Support of other simulators is planned, but Verilator still will be the main simulator for project as it is the only viable option to organize CI.
IMPORTANT: The package is developed and tested using Verilator 5.24 only. Support of other simulators is planned, but Verilator still will be the main simulator for project as it is the only viable option to organize CI and opensource flow.

Include directories and sources are expressed as filelists (.f files):

Expand All @@ -43,7 +43,9 @@ To integrate the package into your code you need:

* Clone `sv-json` repository
* Set environment variable `SV_JSON_ROOT` with a path to `sv-json` root on your filesystem
* Add filelist to your simulator using according arguments, e.g. `-f ${SV_JSON_ROOT}/src/filelist.f` or `-file ${SV_JSON_ROOT}/src/filelist.f` depending on your simulator.
* Add filelist to your simulator using according arguments, e.g.
** `-f ${SV_JSON_ROOT}/src/filelist.f`
** or `-file ${SV_JSON_ROOT}/src/filelist.f` depending on your simulator.

Then follow https://esynr3z.github.io/sv-json[User guide] section to get instructions on how to use JSON encoder and decoder in practice.

Expand Down

0 comments on commit 6cad5ae

Please sign in to comment.