AtHeartEngineer/kami
1
0
Fork 0
mirror of https://github.com/JHUAPL/kami.git synced 2026-01-10 07:17:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Start installation instructions in Markdown

Browse Source
This commit is contained in:
James P. Howard, II
2021-09-21 20:58:47 -04:00
parent f474d6feff
commit 30fdd46d93
2 changed files with 24 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/installation.md Normal file
View File

@@ -0,0 +1,24 @@
# Installation
## Requirements
The core of Kami, `libkami` has no requirements beyond a modern C++ compiler. However, both the examples provided and
the
## Compiling
To compile and test locally in kami/build:
git clone https://github.com/k3jph/kami.git
cd kami
conan install -if build .
cmake -B build -DBUILD_SHARED_LIBS:BOOL=FALSE
cmake --build build
cmake --build build --target test
## Conan Installation (Local)
To install via [Conan](https://conan.io/):
conan create . kami/develop

19
docs/installation.rst
View File

@@ -1,19 +0,0 @@
Installation
============
Compiling
---------
To compile and test locally in kami/build::
git clone https://github.com/k3jph/kami.git
cd kami
conan install -if build .
cmake -B build -DBUILD_SHARED_LIBS:BOOL=FALSE
cmake --build build
cmake --build build --target test
Conan Installation
------------------
Forthcoming.