From 7d578000462f011a4c5c88f4ca2c00eab0e37ce0 Mon Sep 17 00:00:00 2001
From: Chris Cromer <chris@cromer.cl>
Date: Mon, 17 Apr 2023 20:42:26 -0400
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f9b81b6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Obelisk
+
+The Obelisk project is a declarative language designed to help with the implementation of Artificial Intelligence using an easy to use logical programming language.
+
+## Build requirements
+
+ - Meson
+ - Ninja
+ - LLVM 14
+ - sqlite 3
+ - C++ 17
+ - C 17
+
+## Build
+
+```
+meson builddir
+cd buildir
+ninja
+```
+
+This process will generate the binary "obelisk", a shared library "libobelisk.so", and a static library "libobelisk.a".
+
+The binary is used to compile and create obelisk knowledge bases and the the libraries can be linked against to consult the Obelisk knowledge base from any software that can link with the libraries.
+
+## Install
+
+```
+ninja install
+```
+
+This will install the Obelisk cli and the Obelisk library globally. You can also copy the resulting shared and/or static library to a project to link against and use an Obelisk knowledge base.
+
+## License
+
+Obelisk is licensed under the [The 3-Clause BSD License](LICENSE).
+
+## Authors
+
+ - Christopher Cromer
+ - Martín Araneda