From 03568c3a258a325ab264777c0f710121e7ac88b1 Mon Sep 17 00:00:00 2001 From: NotAShelf Date: Sun, 2 Nov 2025 19:52:58 +0300 Subject: [PATCH] docs: add very basic README So it doesn't look so empty in here... Signed-off-by: NotAShelf Change-Id: Icff5e32cef6d19e42107f0f4945f26b06a6a6964 --- README.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fedca69 --- /dev/null +++ b/README.md @@ -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.