Skip to content

Commit

Permalink
Minor fix in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MischaPanch authored Apr 18, 2024
1 parent 7b486a4 commit b7eef62
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The template supports python 3.11 and higher. For a smooth project generation yo
Call

```shell script
cookiecutter https://github.com/appliedAI-Initiative/python_library_template -o path/to/directory
cookiecutter https://github.com/appliedAI-Initiative/pymetrius -o path/to/directory
```

and walk through the questions. You can also clone this repository, adjust the template and call cookiecutter on
Expand All @@ -48,6 +48,10 @@ poe format
git add . && git commit -m "Initial commit from pymetrius"
```

Note: if you want to use `sphinx-spelling`, as is configured by default in the `poe` tasks, you may need to install the `enchant` library,
see [installation instructions](https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library). Otherwise, you
can just remove the spellcheck from the tasks.

Push to your branch and enjoy the fully setup pipelines and documentation!


Expand Down

0 comments on commit b7eef62

Please sign in to comment.