Skip to content

Commit 3013ed2

Browse files
committed
README updates
1 parent 01f7654 commit 3013ed2

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Make sure that your Python installation allows you to run `python` from the comm
3737
4. Click "Next," then "Finish."
3838

3939
### Running the tests
40-
It is possible to run all the tests in one go, or just run one part of the tests to verify a single part of TinCanPython. The tests are located in `TinCanPython/test`.
40+
It is possible to run all the tests in one go, or just run one part of the tests to verify a single part of TinCanPython. The tests are located in `test/`.
4141

4242
#### All the tests:
4343
1. `cd` to the `test` directory.
@@ -53,17 +53,25 @@ It is possible to run all the tests in one go, or just run one part of the tests
5353

5454
(or whatever test you want to run)
5555

56+
#### A single test case of one of the tests:
57+
1. `cd` to the directory containing the test.
58+
2. Run
59+
60+
python -m unittest remote_lrs_test.RemoteLRSTest.test_retrieve_statement
61+
62+
Where "remote_lrs_test" is the test file, "RemoteLRSTest" is the class in that file, and "test_retrieve_statement" is the specific test case.
63+
5664
## API doc generation
57-
To automatically generate documentation, go to the `TinCanPython` folder and run the command
65+
To automatically generate documentation, at the root of the repository run,
5866

5967
sphinx-apidoc -o ./docs/source/ tincan/
6068

61-
Then from the `TinCanPython/docs` folder run
69+
Then from the `docs/` directory run,
6270

6371
make html
6472

65-
The docs will be put in `TinCanPython/docs/build/html/index.html`.
73+
The docs will be output to `docs/build/html/`.
6674

67-
If you would like to change the names of each section, you can do so by modifying `TinCanPython/docs/source/tincan.rst`.
75+
If you would like to change the names of each section, you can do so by modifying `docs/source/tincan.rst`.
6876

6977
## Releasing

0 commit comments

Comments
 (0)