Skip to content

Commit 3fe14af

Browse files
Note about Git submodules in README.rst
1 parent 4afa45f commit 3fe14af

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.rst

+14-6
Original file line numberDiff line numberDiff line change
@@ -190,16 +190,24 @@ 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
194+
``json-ld-api``, ``json-ld-framing``, and ``rdf-canon`` repositories hosted
195+
on GitHub:
196196

197197
- https://github.com/w3c/json-ld-api
198198
- https://github.com/w3c/json-ld-framing
199-
- https://github.com/json-ld/normalization
199+
- https://github.com/w3c/rdf-canon
200200

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:
201+
They are included beneath ``specifications`` directory of this repository as
202+
Git submodules. By default, ``git clone`` does
203+
not retrieve submodules; to download them, please issue the following command:
204+
205+
.. code-block:: bash
206+
207+
git submodule update --init --recursive
208+
209+
If the suites repositories are available then all the tests can be run with
210+
the following:
203211

204212
.. code-block:: bash
205213

0 commit comments

Comments
 (0)