update README

This commit is contained in:
Max Erenberg 2021-10-05 00:10:15 -04:00
parent 1fcc49ef12
commit 1fbc068f3b
2 changed files with 3 additions and 1 deletions

View File

@ -2,9 +2,11 @@
[![Build Status](https://ci.csclub.uwaterloo.ca/api/badges/public/pyceo/status.svg?ref=refs/heads/v1)](https://ci.csclub.uwaterloo.ca/public/pyceo)
CEO (**C**SC **E**lectronic **O**ffice) is the tool used by CSC to manage
club accounts and memberships. See [architecture.md](architecture.md) for an
club accounts and memberships. See [docs/architecture.md](docs/architecture.md) for an
overview of its architecture.
The API documentation is available as a plain HTML file in [docs/redoc-static.html](docs/redoc-static.html).
## Development
### Docker
If you are not modifying code related to email or Mailman, then you may use