[readme] add TOC and conform to linter suggestions
This commit is contained in:
parent
95905709d9
commit
064bf1db36
1 changed files with 21 additions and 7 deletions
28
README.md
28
README.md
|
@ -7,21 +7,35 @@
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
|
<!--toc:start-->
|
||||||
|
|
||||||
|
- [Development](#development)
|
||||||
|
- [Getting started](#getting-started)
|
||||||
|
- [Python](#python)
|
||||||
|
- [PostgreSQL](#postgresql)
|
||||||
|
- [Get the code](#get-the-code)
|
||||||
|
- [Making changes](#making-changes)
|
||||||
|
- [Using the App](#using-the-app)
|
||||||
|
- [Dependency management](#dependency-management)
|
||||||
|
- [Installing dependencies](#installing-dependencies)
|
||||||
|
|
||||||
|
<!--toc:end-->
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
This project makes use of several tools:
|
This project makes use of several tools:
|
||||||
|
|
||||||
* [direnv] is used to set up environment variables and activate the virtualenv. I
|
- [direnv] is used to set up environment variables and activate the virtualenv. I
|
||||||
recommend installing it and integrate it into your favourite shell.
|
recommend installing it and integrate it into your favourite shell.
|
||||||
* [just] is used as a task runner.
|
- [just] is used as a task runner.
|
||||||
* [woodpecker-cli] is used to lint `.woodpecker/workflow.yaml`. It is available
|
- [woodpecker-cli] is used to lint `.woodpecker/workflow.yaml`. It is available
|
||||||
from [homebrew].
|
from [homebrew].
|
||||||
* [pytest] is the test runner. Invoke it using `just test` (any arguments will be
|
- [pytest] is the test runner. Invoke it using `just test` (any arguments will be
|
||||||
passed through to pytest).
|
passed through to pytest).
|
||||||
Several pytest-plugins are used:
|
Several pytest-plugins are used:
|
||||||
* [hypothesis]
|
- [hypothesis]
|
||||||
* [pytest-django]
|
- [pytest-django]
|
||||||
* [pytest-cov]
|
- [pytest-cov]
|
||||||
|
|
||||||
### Getting started
|
### Getting started
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue