Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation on how to build and run the project #304

Merged
merged 4 commits into from
May 30, 2024
Merged

Add documentation on how to build and run the project #304

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76e11e4
Add documentation on how to build and run the project
niccokunzmann Apr 24, 2024
136b418
update serve command
niccokunzmann May 18, 2024
008bae4
Update test command
niccokunzmann May 18, 2024
f868bd1
add style:check to documentation
niccokunzmann May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ But also in our hall of fame:

Feel free to ask questions, enhancements and to contribute to this project!

## Development

The project is managed with `hatch`. [Install `hatch`](https://hatch.pypa.io/1.9/install/#gui-installer) first.

Run the tests:

```
hatch test
niccokunzmann marked this conversation as resolved.
Show resolved Hide resolved
```

Serve the documentation:

```
hatch -e docs run mkdocs serve
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs is actually conflicting with the docs/ folder of the project which makes this command break, thanks for letting me see it :)

I'll open a PR to fix that first!

niccokunzmann marked this conversation as resolved.
Show resolved Hide resolved
```

## Credits

- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)
- Logo by [max.icons](https://www.flaticon.com/authors/maxicons)
Loading