Add documentation on how to run tests
This commit is contained in:
parent
4667c85e00
commit
f73e3d5f8c
37
README.md
37
README.md
@ -26,9 +26,11 @@ It supports Python 3 and Anki 2.1.
|
|||||||
- [Installing](#installing)
|
- [Installing](#installing)
|
||||||
- [Installing (Docker)](#installing-docker)
|
- [Installing (Docker)](#installing-docker)
|
||||||
- [Setting up Anki](#setting-up-anki)
|
- [Setting up Anki](#setting-up-anki)
|
||||||
- [Anki 2.1](#anki-21)
|
- [Anki 2.1](#anki-21)
|
||||||
- [Anki 2.0](#anki-20)
|
- [Anki 2.0](#anki-20)
|
||||||
- [AnkiDroid](#ankidroid)
|
- [AnkiDroid](#ankidroid)
|
||||||
|
- [Development](#development)
|
||||||
|
- [Testing](#testing)
|
||||||
- [ENVVAR configuration overrides](#envvar-configuration-overrides)
|
- [ENVVAR configuration overrides](#envvar-configuration-overrides)
|
||||||
- [Support for other database backends](#support-for-other-database-backends)
|
- [Support for other database backends](#support-for-other-database-backends)
|
||||||
</details>
|
</details>
|
||||||
@ -142,6 +144,35 @@ Even though the AnkiDroid interface will request an email address, this is not
|
|||||||
required; it will simply be the username you configured with `ankisyncctl.py
|
required; it will simply be the username you configured with `ankisyncctl.py
|
||||||
adduser`.
|
adduser`.
|
||||||
|
|
||||||
|
Development
|
||||||
|
-----------
|
||||||
|
|
||||||
|
### Testing
|
||||||
|
|
||||||
|
0. Prerequites
|
||||||
|
|
||||||
|
This project uses [GNU Make](https://www.gnu.org/software/make/) to simplify the development commands. It also uses [Poetry](https://python-poetry.org/) to manage the Python dependencies. Ensure they are installed.
|
||||||
|
|
||||||
|
1. Create a config for your local environment.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cp config/.env.example config/.env.local
|
||||||
|
```
|
||||||
|
|
||||||
|
See [ENVVAR configuration overrides](#envvar-configuration-overrides) for more information.
|
||||||
|
|
||||||
|
2. Download Python dependencies.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make init
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Run unit tests.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ make tests
|
||||||
|
```
|
||||||
|
|
||||||
ENVVAR configuration overrides
|
ENVVAR configuration overrides
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user