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

Small change to readme and re-order

Browse source
This commit is contained in:
Jonathan Hodgson 2020-12-30 19:38:04 +00:00
parent 73894bb252
commit bfd13ecafc
1 changed files with 33 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -6,6 +6,39 @@ 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.
## Goals
### Mostly Plain Text
Most of my notes are currently in Markdown. This has a couple of advantages for
me:
* I can read them anywhere
* I can version control them with Git
* They can be grepped
There may be some exceptions. It is sometimes useful to include screenshots.
These can be added and are version controlled using git lfs.
### Tags
Before starting this project, my notes were organised into folders.
Unfortunately, this makes storing articles or notes that apply to different
areas difficult. I would prefer a tag based system. This would allow a file to
have multiple tags assigned to it.
### Fast
I want to be able to retrieve my notes quickly by tag or by title. To do this,
this tool will index notes using an SQLite database. This will not be version
controlled.
### Don't re-invent the wheel
I will be building on top of already great, fast tools such as
[RipGrep](https://github.com/BurntSushi/ripgrep) and
[FZF](https://github.com/junegunn/fzf).
## Requirements ## Requirements
I don't want to re-invent the wheel. The following tools are used within this I don't want to re-invent the wheel. The following tools are used within this
@ -90,36 +123,3 @@ to delete or `ctrl-n` to create a new file with the current query as the name.
![Fuzzy search](./assets/fuzzy.rec.gif) ![Fuzzy search](./assets/fuzzy.rec.gif)
## Goals
### Mostly Plain Text
Most of my notes are currently in Markdown. This has a couple of advantages for
me:
* I can read them anywhere
* I can version control them with Git
* They can be grepped
There may be some exceptions. I may wish to include links or images which I will
version control with Git LFS; but for the most part, my notes are plain text.
### Tags
Before starting this project, my notes were organised into folders.
Unfortunately, this makes storing articles or notes that apply to different
areas difficult. I would prefer a tag based system. This would allow a file to
have multiple tags assigned to it.
### Fast
I want to be able to retrieve my notes quickly by tag or by title. To do this,
this tool will index notes using an SQLite database. This will not be version
controlled.
### Don't re-invent the wheel
I will be building on top of already great, fast tools such as
[RipGrep](https://github.com/BurntSushi/ripgrep) and
[FZF](https://github.com/junegunn/fzf).