Adds a setup section to the readme

This commit is contained in:
Jonathan Hodgson 2020-12-22 17:38:28 +00:00
parent 5076c4d9bc
commit c4c3027e07

View file

@ -6,6 +6,23 @@ find a tool that fits my requirements / desires so I decided to build one.
This is still in early stages of development so expect braking changes to come
if you use it.
## Setup
After cloning the repository, you can run
```
sudo make install
```
To initialise, run
```
kb init
```
This will create the necessary folders and create an sqlite database to store
the index in
## Goals
### Mostly Plain Text