Add basic README

This commit is contained in:
Pierre Bourdon 2022-12-23 04:13:51 +01:00
parent 09198cb2d3
commit 248edce67c
No known key found for this signature in database
GPG Key ID: 6FB80DCD84DA0F1C

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# Dolphin Central
Central is the infrastructure component receiving webhooks and coordinating
builds, status updates, notifications, etc. for Dolphin's CI/CD infrastructure.
It provides plumbing to connect the following systems together:
- GitHub
- IRC
- Buildbot
- FifoCI
This is not meant as a general purpose system, it is custom made for Dolphin's
needs and likely not directly usable for other projects.
## Setup
```bash
$ nix run
```
## Development
```bash
$ nix develop
$ poetry install
$ poetry run black --check .
$ poetry run pytest
$ poetry run central
```