From c4c3027e079be6ff2fc81532e64f2d614d245746 Mon Sep 17 00:00:00 2001 From: Jonathan Hodgson Date: Tue, 22 Dec 2020 17:38:28 +0000 Subject: [PATCH] Adds a setup section to the readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index ffce23c..b5dfbb4 100644 --- a/README.md +++ b/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