Skip to content

Commit c734ceb

Browse files
authored
docs: Update README (#73)
* feat: update readme Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com> * feat: update readme Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com> --------- Signed-off-by: David Mortensen <156092822+lfvdavid@users.noreply.github.com>
1 parent f46df8e commit c734ceb

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ To use the Reqstool Hatch Plugin, follow these steps:
1717

1818
- Update your project dependencies in the `pyproject.toml` file and
1919
ensure that the Reqstool Decorators' dependency is listed as follows;
20-
```
21-
dependencies = ["reqstool-python-decorators == <version>"]
20+
21+
```toml
22+
dependencies = ["reqstool-python-decorators==<version>"]
2223
```
2324

2425
When you declare this in the pyproject.toml file, you are specifying the required versions for the dependency of the Reqstool Decorators. This ensures that the correct version of the dependencies are used when installing and running your project.
@@ -33,13 +34,23 @@ The plugin can be configured through the `pyproject.toml` file. Configure plugin
3334

3435
```toml
3536
[tool.hatch.build.hooks.reqstool]
36-
dependencies = ["reqstool-python-hatch-plugin == <version>"]
3737
sources = ["src", "tests"]
38+
test_results = "build/**/junit.xml"
3839
dataset_directory = "docs/reqstool"
3940
output_directory = "build/reqstool"
40-
test_results = ["build/**/junit.xml"]
4141
```
4242

43+
And under `requires` in `[build-system]` you need to add the plugin with the version, see example;
44+
45+
```toml
46+
[build-system]
47+
requires = [
48+
"hatchling",
49+
"reqstool-python-hatch-plugin==<version>",
50+
]
51+
```
52+
53+
4354
It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version.
4455

4556
Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories.

0 commit comments

Comments
 (0)