docs: add very basic README

So it doesn't look so empty in here...

Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Icff5e32cef6d19e42107f0f4945f26b06a6a6964
This commit is contained in:
raf 2025-11-02 19:52:58 +03:00
commit 03568c3a25
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF

34
README.md Normal file
View file

@ -0,0 +1,34 @@
# FC
FC is a modern, Rust-based continuous integration system designed to replace
Hydra for our systems. Heavily work in progress.
## Architecture
- **server**: Web API and UI (Axum)
- **evaluator**: Git polling and Nix evaluation
- **queue-runner**: Build dispatch and execution
- **common**: Shared types and utilities
## Development
```bash
nix develop
cargo build
```
## Components
### Server
Web API server providing REST endpoints for project management, jobsets, and
build status.
### Evaluator
Periodically polls Git repositories and evaluates Nix expressions to create
builds.
### Queue Runner
Processes build queue and executes Nix builds on available machines.