X-Git-Url: https://code.consxy.com/gitweb/?a=blobdiff_plain;f=README.md;h=de62c709f3967ccb8b31e3e0772285cd79a0fc5b;hb=05da1587a922cb1fc22cb6aa3ec1e86926328736;hp=14a6262d6eea6bfdf07a171029fc840c6620d101;hpb=88b07c40f1176869b4ed1b7188724c64753ee607;p=candle diff --git a/README.md b/README.md index 14a6262..de62c70 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -= Candle = +# Candle Continuous Integration for SBCL based Lisp projects, using AWS instances as the machines on which the CI's are run. -= .candle file = +# .candle file Each project with a candle file has a .candle file in the root of the project with tasks to be run. -= Limitations = +# Limitations This documentation needs to be updated once more things are working, but this is an early version of everything. @@ -24,7 +24,7 @@ There is also no email, and everything else handled via the CLI. Only one can be running at a time. -= Usage = +# Usage * Run bin/candle-server on a server somewhere, so that the candle client can connect to it * Add projects via `bin/candle project add`, see `--help` for more information @@ -36,6 +36,6 @@ Only one can be running at a time. * Run `bin/candle job log :` to see log * Run `bin/candle job retry :` to retry the job -== Local == +## Local * Run `bin/candle run` from a candle enabled project