aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
author2023-05-06 17:34:07 +0530
committer2023-05-06 17:34:07 +0530
commit38bc1d73a3d6c67d156e0b24980fb6c874d49983 (patch)
treec79f219700a53784977957ad2918a901e64572cc
parentAdded MIT License (diff)
downloadcart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar.gz
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar.bz2
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar.lz
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar.xz
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.tar.zst
cart-38bc1d73a3d6c67d156e0b24980fb6c874d49983.zip
Updated Readme to include build instructions
Signed-off-by: Marc Pervaz Boocha <mboocha@sudomsg.xyz> On branch main Your branch is ahead of 'origin/main' by 1 commit. (use "git push" to publish your local commits) Changes to be committed: modified: readme.md
-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
+```
+