Skip to content

Commit 5763dd0

Browse files
committed
minor readme update
1 parent 08101e7 commit 5763dd0

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ python3 ./setup.py pytest
2020

2121
## Contents
2222

23-
* **`.github/workflows/`** - Directory containing the configuration file for GitHub actions.
24-
* **`.github/workflows/test.yml`** - File detailing the system configurations to use for the tests.
25-
* **sciware_testing_python/** - Directory for all the code.
26-
* **`sciware_testing_python/__init.py__`** - File telling Python what to import with `sciware_testing_python` package.
23+
* **`README.md`** - File generating this page.
24+
* **`setup.py`** - File describing the metadata for the package and rules to build/install/test it.
25+
* **`requirements.txt`** - File listing the packages required to run the code. It is included by setup.py.
26+
* **`LICENSE`** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
27+
* **`sciware_testing_python/`** - Directory for all the code.
28+
* **`sciware_testing_python/__init.py__`** - File that python imports to define the `sciware_testing_python` package.
2729
* **`sciware_testing_python/sciware_testing_python.py`** - File with all of the code.
2830
* **`tests/`** - Directory for the code which tests the code in `sciware_testing_python`.
2931
* **`tests/test_sciware_testing_python.py`** - File containing the tests.
3032
* **`.gitignore`** - File which tells github what files to not track (optional)
31-
* **`LICENSE`** - File containing the text of the license the code is released under. Having a license file allows other people to use the code.
32-
* **`README.md`** - File generating this page.
33-
* **`requirements.txt`** - File listing the packages required to run the code. It is included by setup.py.
34-
* **setup.py** - File describing the metadata for the package and rules to build/install/test it.
33+
* **`.github/workflows/`** - Directory containing the configuration file for GitHub actions.
34+
* **`.github/workflows/test.yml`** - File detailing the system configurations to use for the tests.

0 commit comments

Comments
 (0)