-
-
Notifications
You must be signed in to change notification settings - Fork 38
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.
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
Add documentation on how to build and run the project #304
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You'd also maybe want to add how to run style checks
hatch run style:check
Thanks
README.md
Outdated
Serve the documentation: | ||
|
||
``` | ||
hatch -e docs run mkdocs serve |
There was a problem hiding this comment.
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!
FYI #308 |
Co-authored-by: Ultrabug <ultrabug@users.noreply.github.com>
Co-authored-by: Ultrabug <ultrabug@users.noreply.github.com>
I added it to the documentation. |
1 similar comment
I added it to the documentation. |
Thanks mate, moving on |
This fixes #303
Hatch looks nice!