From 3da95a63fbdcb4bf585306e737d7cae65549905e Mon Sep 17 00:00:00 2001
From: Chewing_Bever <roosensjef@gmail.com>
Date: Wed, 18 Jan 2023 11:49:45 +0100
Subject: [PATCH] chore: add readme

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..07aca0a
--- /dev/null
+++ b/README.md
@@ -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.