Merge pull request 'add readme' (#24) from feature/add_readme into develop

Reviewed-on: #24
This commit is contained in:
Chris Cromer 2023-04-17 20:43:23 -04:00
commit f85f8a4637

41
README.md Normal file
View File

@ -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