Adds a setup section to the readme

master
Jonathan Hodgson 3 years ago
parent 5076c4d9bc
commit c4c3027e07
  1. 17
      README.md

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

Loading…
Cancel
Save