mirror/cadmus
1
0
Fork 0
mirror of https://github.com/RyanGreenup/cadmus.git synced 2025-08-14 01:53:59 +02:00
Code Issues Releases Wiki Activity

Recoll Search Engine

Browse Source
This commit is contained in:
ryangreenup
2020-07-13 01:45:03 +10:00
parent 87e6b56832
commit d34bee12ab
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -26,10 +26,20 @@ stow -t $HOME -S cadmus
## Usage ## Usage
It's all Menu driven so just follow the diagram to do what you need. It's all Menu driven so just follow the diagram to do what you need.
![Mindmap of Program Flow](./usage.svg "Diagram of the flow of the script") ![Mindmap of Program Flow](./usage.svg "Diagram of the flow of the script")
### Assumptions
It is assumed that notes are:
1. *Markdown* files with a `.md` extension
2. Underneath `~/Notes`
3. Recoll updates it's index on the fly
* `~/Notes` will need to be indexed by *Recoll* so the results will show up.
## Dependencies ## Dependencies
- [R](https://en.wikipedia.org/wiki/R_(programming_language)) - [R](https://en.wikipedia.org/wiki/R_(programming_language))