aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 5c8cd12fea8bfaf330723c886c2ccdad7240bf56 (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
# Stars

This is an SFML project I made to show Kruskal's algorithm in slow motion.

## Build requirements

- C++ buildsystem.
- CMake >= 3.8.
- SFML >= 2.

## Build steps

### *nix

```sh
sh config.sh
cmake --build build
```

### Windows

```PowerShell
.\config.ps1
cmake --build build
```

## Developer instructions

### Coverage
To generate coverage reports, build the project with
`-DCMAKE_BUILD_TYPE=Coverage`, then from the `build/` directory, execute
`src/main`. Perform actions, exit cleanly, then run `make coverage`. Coverage
reporting is supported on Apple (LLVM) and Linux (gcov/lcov).

## Bug reports, questions, etc.

* The stars homepage is hosted at <https://git.aidenw.net/stars/about/>
* Patches, bug reports, and support should go to Aiden Woodruff <aiden@aidenw.net>.