Add a requirements section to the readme
This commit is contained in:
parent
4731545df5
commit
18cd642ce3
1 changed files with 39 additions and 1 deletions
40
README.md
40
README.md
|
@ -6,6 +6,42 @@ 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.
|
||||
|
||||
## Requirements
|
||||
|
||||
I don't want to re-invent the wheel. The following tools are used within this
|
||||
project:
|
||||
|
||||
### FZF
|
||||
|
||||
https://github.com/junegunn/fzf
|
||||
|
||||
This is used for the fuzzy searching
|
||||
|
||||
### Git
|
||||
|
||||
https://git-scm.com/
|
||||
|
||||
Git is used for version controlling the knowledge base. If you don't want to use
|
||||
git, you can use the --nogit option
|
||||
|
||||
### Git-LFS
|
||||
|
||||
https://github.com/git-lfs/git-lfs
|
||||
|
||||
Vanilla git is not very good at version controlling binary files. Git LFS allows
|
||||
assets to be stored separately from the main repository but referenced.
|
||||
|
||||
### Bat
|
||||
|
||||
https://github.com/sharkdp/bat
|
||||
|
||||
This is used to provide syntax highlighting in previews
|
||||
|
||||
### Sqlite3
|
||||
|
||||
This is used to index the documents in the knowledge base, making it fast to
|
||||
search by tag etc.
|
||||
|
||||
## Setup
|
||||
|
||||
After cloning the repository, you can run
|
||||
|
@ -14,6 +50,7 @@ After cloning the repository, you can run
|
|||
sudo make install
|
||||
```
|
||||
|
||||
|
||||
To initialise, run
|
||||
|
||||
```
|
||||
|
@ -21,7 +58,8 @@ kb init
|
|||
```
|
||||
|
||||
This will create the necessary folders and create an sqlite database to store
|
||||
the index in
|
||||
the index in.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue