Improve Python documentation

This commit is contained in:
emily 2023-11-03 15:14:14 +01:00
parent 977f89afd9
commit 3fb6c60ad1

25
python/README.md Normal file
View File

@ -0,0 +1,25 @@
# Gilded Rose starting position in Python
## Run the unit tests from the Command-Line
```
python test_gilded_rose.py
```
### Run the TextTest fixture from the Command-Line
For e.g. 10 days:
```
python texttest_fixture 10
```
You should make sure the command shown above works when you execute it in a terminal before trying to use TextTest (see below).
## Run the TextTest approval test that comes with this project
There are instructions in the [TextTest Readme](../texttests/README.md) for setting up TextTest. You will need to specify the Python executable and interpreter in [config.gr](../texttests/config.gr). Uncomment these lines:
executable:${TEXTTEST_HOME}/python/texttest_fixture.py
interpreter:python