jab2870/knowledge-base
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Wiki Activity

Adds a setup section to the readme

Browse source
This commit is contained in:
Jonathan Hodgson 2020-12-22 17:38:28 +00:00
parent 5076c4d9bc
commit c4c3027e07
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
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 This is still in early stages of development so expect braking changes to come
if you use it. 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 ## Goals
### Mostly Plain Text ### Mostly Plain Text