diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca0491e --- /dev/null +++ b/README.md @@ -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 +```