update documentation
This commit is contained in:
parent
058ab5d062
commit
b6fcf45aa2
|
@ -7,8 +7,10 @@ Memo organizes is structured through topics which are folders in `~/memo`.
|
|||
## Features
|
||||
|
||||
* add text to a topic to memorize it
|
||||
* remote topics
|
||||
* search for strings in your memo-database
|
||||
* copy/import files to topic folder.
|
||||
* git support
|
||||
|
||||
## Run
|
||||
|
||||
|
@ -19,7 +21,8 @@ Memo organizes is structured through topics which are folders in `~/memo`.
|
|||
* tree
|
||||
* ack
|
||||
* man
|
||||
* pandoc
|
||||
* git
|
||||
* pandoc (optional)
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
19
doc/memo.1
19
doc/memo.1
|
@ -1,5 +1,5 @@
|
|||
.\" Text automatically generated by txt2man
|
||||
.TH memo 1 "17 May 2018" "doc" "Linux Reference Manual"
|
||||
.TH memo 1 "10 August 2018" "doc" "Linux Reference Manual"
|
||||
.SH NAME
|
||||
\fBmemo
|
||||
\fB
|
||||
|
@ -30,6 +30,10 @@ adds text to the memo.md in the topic folder.
|
|||
if text is not given it will read from stdin.
|
||||
.TP
|
||||
.B
|
||||
rm <topic>
|
||||
remove $MEMO_DIR/topic folder with all it's content.
|
||||
.TP
|
||||
.B
|
||||
copy <topic> <file-to-copy>
|
||||
copy a file to the topic folder.
|
||||
.TP
|
||||
|
@ -49,6 +53,11 @@ opens your favorite editor to edit the \fBmemo\fP topic
|
|||
.B
|
||||
list
|
||||
prints a list of all topics.
|
||||
.TP
|
||||
.B
|
||||
git <command>
|
||||
run git command in $MEMO_DIR.
|
||||
Once $MEMO_DIR is a git repository all \fBmemo\fP commands create commits.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
|
@ -91,5 +100,13 @@ Copy the "Invoice.pdf" file to the "lawsuit" topic.
|
|||
.fam C
|
||||
$> memo copy lawsuit ~/Downloads/Invoice.pdf
|
||||
|
||||
.fam T
|
||||
.fi
|
||||
Make $MEMO_DIR a git repository.
|
||||
.PP
|
||||
.nf
|
||||
.fam C
|
||||
$> memo git init
|
||||
|
||||
|
||||
|
||||
|
|
|
@ -17,6 +17,8 @@ COMMANDS
|
|||
add <topic> [text] adds text to the memo.md in the topic folder.
|
||||
if text is not given it will read from stdin.
|
||||
|
||||
rm <topic> remove $MEMO_DIR/topic folder with all it's content.
|
||||
|
||||
copy <topic> <file-to-copy> copy a file to the topic folder.
|
||||
|
||||
search <term-to-search> search for a term in $MEMO_DIR using ack.
|
||||
|
@ -28,6 +30,9 @@ COMMANDS
|
|||
|
||||
list prints a list of all topics.
|
||||
|
||||
git <command> run git command in $MEMO_DIR.
|
||||
Once $MEMO_DIR is a git repository all memo commands create commits.
|
||||
|
||||
|
||||
|
||||
CONFIGURATION
|
||||
|
@ -54,5 +59,9 @@ EXAMPLE
|
|||
|
||||
$> memo copy lawsuit ~/Downloads/Invoice.pdf
|
||||
|
||||
Make $MEMO_DIR a git repository.
|
||||
|
||||
$> memo git init
|
||||
|
||||
|
||||
|
||||
|
|
Loading…
Reference in a new issue