2 files changed, 40 insertions, 33 deletions
diff --git a/README b/README
deleted file mode 100644
@@ -1,33 +0,0 @@
-The last C datastructure library you will use. Provides a versatile
-structure that can act as lists, sets and more!
-Issues are being tracked here: https://todo.sr.ht/~spacekookie/libbowl
-How to build
-An out-of-source build is recommended.
-$> mkdir build; cd build
-$> cmake ..
-$> make -j 2
-This will create a `.so` file. If you require a static object, you can
-change the linking behaviour in the `CMakeLists.txt` file.
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 3 of the License, or (at
-your option) any later version.
-I hope you enjoy ❤
diff --git a/README.md b/README.md
new file mode 100644
@@ -0,0 +1,40 @@
+The last C datastructure library you will ever use. Provides a
+versalite API to build nested, serial and hashed structure nodes.
+Check out the [issue tracker][issues]
+I hope you enjoy ❤
+How to build
+- gcc (`4.0+`)
+- cmake (`2.18+`)
+An out-of-source build is recommended. You can specify the linking
+behaviour with `-DLINK_DYNAMIC=1`. Optionally you can disable tests
+$ mkdir build; cd build
+$ cmake .. -DLINK_DYNAMIC=1 -DRUN_TESTS=1
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 3 of the License, or (at
+your option) any later version.