chore: add readme

main
Jef Roosens 2023-01-18 11:49:45 +01:00
parent be97472dcc
commit 3da95a63fb
Signed by: Jef Roosens
GPG Key ID: B75D4F293C7052DB
1 changed files with 26 additions and 0 deletions

26
README.md 100644
View File

@ -0,0 +1,26 @@
# libvieter
This library powers part of Vieter, most noteably the sections that can easily
be implemented in C (or just parts I want to implement in C because it's fun).
The goal of this library is to be completely self-contained, meaning any
required data structures have to be implemented as well. It can only depend on
the C standard libraries.
Currently it contains the following:
* Cron expression parser & next time calculator
## Development
### `compile_commands.json`
Clangd requires a `compile_commands.json` to function properly. You can
generate it using [bear](https://github.com/rizsotto/Bear):
```sh
make clean
bear -- make
```
This will create a `compile_commands.json` file in the current directory.