aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
blob: 1f4e4ea9e870b5d4564dbf3194c2898416846119 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
cimple
======

My little CI system (hopefully).

_This is work in progress; it doesn't quite work the way I want it to yet._

Development
-----------

Build using CMake.
Depends on libgit2 and SQLite.

There's a Makefile with useful shortcuts to build the project in the "build/"
directory:

    make build

This command makes a CMake build directory in build/cmake/ and executes `make`
there.

The default is to build using clang in `Release` configuration.
You can choose a different compiler and configuration like so:

    make build COMPILER=gcc CONFIGURATION=Debug

### Testing

After building, you can run the "test suite" (depends on Pytest).

    make test

### Code style

Set up the git pre-commit hook by running `./scripts/setup-hooks.sh`.
This depends on `clang-format` and won't allow you to commit code that doesn't
pass the formatting check.

Rationale
---------

The goal it to make a CI system that doesn't suck.
See [rationale.md] for details.

[rationale.md]: doc/rationale.md

License
-------

Distributed under the MIT License.
See [LICENSE.txt] for details.

[LICENSE.txt]: LICENSE.txt