Skip to content

Commit

Permalink
docs: Update readme with all commands
Browse files Browse the repository at this point in the history
  • Loading branch information
saattrupdan committed Jul 15, 2024
1 parent bdaeb03 commit 4ba194b
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion {{cookiecutter.project_name}}/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Developer(s):

1. Run `make install`, which sets up a virtual environment and all Python dependencies therein.
2. Run `source .venv/bin/activate` to activate the virtual environment.
3. (Optional) Run `make add-rag` to add RAG functionality from [ragger](https://github.com/alexandrainst/ragger).
3. (Optional) Run `make install-pre-commit`, which installs pre-commit hooks for linting, formatting and type checking.
4. (Optional) Run `make add-rag` to add RAG functionality from [ragger](https://github.com/alexandrainst/ragger).

### Adding and Removing Packages

Expand All @@ -37,6 +38,22 @@ To show all installed packages, run:
{{'poetry show' if cookiecutter.dependency_manager != 'pip' else 'pip list'}}
```
## All Built-in Commands
The project includes the following convenience commands:
- `make install`: Install the project and its dependencies in a virtual environment.
- `make install-pre-commit`: Install pre-commit hooks for linting, formatting and type checking.
- `make lint`: Lint the code using `ruff`.
- `make type-check`: Type check the code using `mypy`.
- `make test`: Run tests using `pytest` and update the coverage badge in the readme.
- `make docker`: Build a Docker image and run the Docker container.
- `make add-rag`: Add RAG functionality from [ragger](https://github.com/alexandrainst/ragger).
- `make update-rag`: Update RAG functionality from [ragger](https://github.com/alexandrainst/ragger).
- `make docs`: Generate HTML documentation using `pdoc`.
- `make view-docs`: View the generated HTML documentation in a browser.
- `make tree`: Show the project structure as a tree.
## A Word on Modules and Scripts
In the `src` directory there are two subdirectories, `{{ cookiecutter.project_name }}`
Expand Down

0 comments on commit 4ba194b

Please sign in to comment.