aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--readme.md18
1 files changed, 16 insertions, 2 deletions
diff --git a/readme.md b/readme.md
index 06bb40a..fbf1f49 100644
--- a/readme.md
+++ b/readme.md
@@ -1,5 +1,19 @@
-# CALT
+# C-ALT
-A C library that is to implement extend and be an alternative to the C stdard library
+A C library that is to implement extend and be an alternative to the C stdard library.
## Note: This is alpha quality software
+
+## Build Instructions
+
+Requirements:
+- [Meson](https://mesonbuild.com)
+- [Ninja](https://ninja-build.org/)
+- A C compiler which supports C11 or higher.
+
+To Build:
+```sh
+meson build
+ninja -C build
+```
+