From 4ba194bd4edd2a974ebb033bb6bc5ea232f5fa5b Mon Sep 17 00:00:00 2001 From: saattrupdan Date: Mon, 15 Jul 2024 16:06:29 +0200 Subject: [PATCH] docs: Update readme with all commands --- {{cookiecutter.project_name}}/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/{{cookiecutter.project_name}}/README.md b/{{cookiecutter.project_name}}/README.md index bf3e72a..696f429 100644 --- a/{{cookiecutter.project_name}}/README.md +++ b/{{cookiecutter.project_name}}/README.md @@ -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 @@ -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 }}`