Skip to content

Commit

Permalink
docs: fix repository name
Browse files Browse the repository at this point in the history
  • Loading branch information
esynr3z committed May 26, 2024
1 parent c9fa186 commit 1958b25
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ site:
start_page: json_pkg::overview.adoc
content:
sources:
- url: https://github.com/esynr3z/sv-json.git
- url: https://github.com/esynr3z/svjson.git
start_path: docs
branches: [main]
asciidoc:
Expand Down
14 changes: 7 additions & 7 deletions docs/modules/ROOT/pages/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:url-ecma-404: https://ecma-international.org/publications-and-standards/standards/ecma-404
:url-sv-json-pages: https://esynr3z.github.io/sv-json
:url-svjson-pages: https://esynr3z.github.io/svjson
:url-svunit: https://github.com/svunit/svunit
:url-json-test-suite: https://github.com/nst/JSONTestSuite
:url-verilator-github: https://github.com/verilator/verilator
Expand All @@ -9,8 +9,8 @@
:url-conventional-commits: https://www.conventionalcommits.org/en/v1.0.0
:url-keep-a-changelog: https://keepachangelog.com/en/1.1.0
:url-semantic-versioning: https://semver.org/spec/v2.0.0.html
:url-tests-badge: https://github.com/esynr3z/sv-json/actions/workflows/tests.yaml/badge.svg?branch=main
:url-documentation-badge: https://github.com/esynr3z/sv-json/actions/workflows/docs.yaml/badge.svg?branch=main
:url-tests-badge: https://github.com/esynr3z/svjson/actions/workflows/tests.yaml/badge.svg?branch=main
:url-documentation-badge: https://github.com/esynr3z/svjson/actions/workflows/docs.yaml/badge.svg?branch=main

= JSON encoder and decoder in SystemVerilog
:navtitle: Overview
Expand All @@ -36,7 +36,7 @@ Known limitations:
* Nesting depth is limited for decoder (1024 by default, limit is controllable)
* No recursion detection for encoder

Detailed documentaion can be found on {url-sv-json-pages}[project's site].
Detailed documentaion can be found on {url-svjson-pages}[project's site].

== Integration

Expand All @@ -56,13 +56,13 @@ For convenient integration they are united into single `filelist.f`.

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
* Clone `svjson` repository
* Set environment variable `SV_JSON_ROOT` with a path to `svjson` 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.

Then follow {url-sv-json-pages}[User guide] section to get instructions on how to use JSON encoder and decoder in practice.
Then follow {url-svjson-pages}[User guide] section to get instructions on how to use JSON encoder and decoder in practice.

== Development

Expand Down

0 comments on commit 1958b25

Please sign in to comment.