Skip to content

Commit 3ebcff9

Browse files
Note about Git submodules in README.rst
1 parent c39ca9e commit 3ebcff9

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.rst

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,16 +190,21 @@ Tests
190190
This library includes a sample testing utility which may be used to verify
191191
that changes to the processor maintain the correct output.
192192

193-
To run the sample tests you will need to get the test suite files by cloning
194-
the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
195-
hosted on GitHub:
193+
To run the sample tests you will need the test suite files provided in the ``json-ld-api``,
194+
``json-ld-framing``, and ``rdf-canon`` repositories hosted on GitHub:
196195

197196
- https://github.com/w3c/json-ld-api
198197
- https://github.com/w3c/json-ld-framing
199-
- https://github.com/json-ld/normalization
198+
- https://github.com/w3c/rdf-canon
200199

201-
If the suites repositories are available as sibling directories of the PyLD
202-
source directory, then all the tests can be run with the following:
200+
They are included beneath ``specifications`` directory of this repository as Git submodules. By default, ``git clone`` does
201+
not retrieve submodules; to download them, please issue the following command:
202+
203+
.. code-block:: bash
204+
205+
git submodule update --init --recursive
206+
207+
If the suites repositories are available then all the tests can be run with the following:
203208

204209
.. code-block:: bash
205210

0 commit comments

Comments
 (0)