aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1372add
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+cimple
+======
+
+My little CI system (hopefully).
+
+Development
+-----------
+
+Build using CMake.
+Depends on libgit2.
+
+There's a Makefile with useful shortcuts to build the project in the .build/
+directory:
+
+ make build
+
+### Code style
+
+Set up the git pre-commit hook by running `./scripts/setup-hook`.
+This depends on `clang-format` and won't allow you to commit code that doesn't
+pass the formatting check.
+
+License
+-------
+
+Distributed under the MIT License.
+See [LICENSE.txt] for details.
+
+[LICENSE.txt]: LICENSE.txt