2017-05-30 20:35:42 +02:00
|
|
|
# memo
|
2017-06-02 00:10:06 +02:00
|
|
|
|
2017-06-19 22:15:52 +02:00
|
|
|
A simple tool written in bash to memorize stuff.
|
2017-06-02 00:10:06 +02:00
|
|
|
|
2017-06-19 22:15:52 +02:00
|
|
|
Memo organizes is structured through topics which are folders in `~/memo`.
|
2017-06-02 00:10:06 +02:00
|
|
|
|
2017-06-19 22:15:52 +02:00
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
* add text to a topic to memorize it
|
2018-08-10 00:32:56 +02:00
|
|
|
* remote topics
|
2017-06-19 22:15:52 +02:00
|
|
|
* search for strings in your memo-database
|
|
|
|
|
* copy/import files to topic folder.
|
2018-08-10 00:32:56 +02:00
|
|
|
* git support
|
2017-06-02 00:10:06 +02:00
|
|
|
|
|
|
|
|
## Run
|
|
|
|
|
|
|
|
|
|
`./memo` shows how to use it
|
|
|
|
|
|
2018-05-17 19:40:00 +02:00
|
|
|
### Dependencies
|
2017-06-02 00:10:06 +02:00
|
|
|
|
|
|
|
|
* tree
|
|
|
|
|
* ack
|
2018-05-17 19:40:00 +02:00
|
|
|
* man
|
2018-08-10 00:32:56 +02:00
|
|
|
* git
|
|
|
|
|
* pandoc (optional)
|
2017-06-02 00:10:06 +02:00
|
|
|
|
2017-06-02 21:56:14 +02:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
* Gentoo : use [my overlay](https://github.com/mrVanDalo/overlay) and install `app-misc/memo`
|
2018-05-17 19:39:13 +02:00
|
|
|
* NixOs : just do `nix-shell -p memo`
|
2017-06-02 21:56:14 +02:00
|
|
|
|
2017-06-02 00:10:06 +02:00
|
|
|
## Configuration
|
|
|
|
|
|
2017-06-19 22:15:52 +02:00
|
|
|
to change the folder where memo kept its files just add
|
2017-06-02 00:10:06 +02:00
|
|
|
|
|
|
|
|
export MEMO_DIR=/path/to/memo/folder
|
2017-06-02 21:56:14 +02:00
|
|
|
|
2017-06-02 00:10:06 +02:00
|
|
|
in your `~/.bashrc`.
|
