docs: add a README.md

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2026-10-18 19:10:37 +08:00 · 2023-12-08 14:24:46 +02:00
parent 2ee1fbf028
commit 6907e36121
1 changed files with 16 additions and 0 deletions
@@ -0,0 +1,16 @@
+# radicle-native-ci
+
+This is an adapter for Radicle CI, for performing CI runs locally.
+It's meant to be used with, and executed by, `radicle-c-broker`.
+
+The CI run is performed locally, without any isolation. This is not
+safe and secure, but it's simple, and easy to get working. Do not use
+this unless you trust the repository.
+
+The repository must contain a file `.ci/radicle.yaml` that
+specifies how CI is run for the repository. For example:
+
+```yaml
+shell: |
+  cargo test --locked --workspace
+```