add building docs

This commit is contained in:
kxtzownsu 2024-11-06 22:16:19 -05:00 committed by kxtz smith
parent 0e5e14edd1
commit 96ed622734
2 changed files with 56 additions and 0 deletions

View File

@ -9,6 +9,8 @@ KVSFLIST := \
CFLAGS := \ CFLAGS := \
-Iinclude \ -Iinclude \
-g \ -g \
-O3 \
-Llib \
-static -static
$(shell mkdir -p build) $(shell mkdir -p build)

54
docs/BUILDING.md Normal file
View File

@ -0,0 +1,54 @@
# Building KVS:
### Dependencies
You only need gcc & make! All static libs are inside `lib/`
```
Debian-based systems: sudo apt install gcc make
Arch-based systems: sudo pacman -S gcc make
Alpine-based systems: apk add gcc make
```
### Compiling:
To compile KVS, you only need to run a few commands
```
# First, clone the repo (insiders, use KVS-private)
git clone https://github.com/kxtzownsu/KVS
# Second, go into the directory (again, insiders, use KVS-private)
cd KVS
# Third, run two command to compile the KVS & KVG binary
make kvs # final binary is at ./build/kvs
make kvg # final binary is at ./build/kvg
# (OPTIONAL) Fourth, run the shim builder
sudo make shim-builder
# You can also run this instead of make
cd shim-builder/
sudo bash builder.sh
```
Notes: KVS **requires** KVG or else the shim will not build successfully
# Building KVG:
### Dependencies
Same as KVS, you only need `gcc` and `make`
```
Debian-based systems: sudo apt install gcc make
Arch-based systems: sudo pacman -S gcc make
Alpine-based systems: apk add gcc make
```
### Compiling
```
git clone https://github.com/kxtzownsu/KVS # insiders, use KVS-private
cd KVS
make kvg # final binary will be at ./build/kvg
```