diff --git a/README.html b/README.html new file mode 100644 index 0000000..44cf0a4 --- /dev/null +++ b/README.html @@ -0,0 +1,212 @@ + + + + + + + README + + + + +
+

README

+
+

n!

+

n! is shell powered note taking tool. Notes are +stored locally in $HOME/.local/nexclamation/notes by +default as plain text.

+

n! depends on Bash, GNU coreutils, find, sed, awk. +Usually these programs are already installed on most Linux distros.

+

Installation

+
make install
+

Uninstall by:

+
make uninstall
+

Usage

+
Usage: n! [-v|--version] [-h|--help] [<command>] [<args>...]
+
+Commands and options:
+    q, quick [<name>]       take a quick note in current directory.
+    s, search <query>       search in notes via grep.
+    l, last                 open last opened file in editor.
+    mkdir <dir>             add new directory. Creates new dir in NPATH.
+    ls [<dir>]              list all notes, or notes from <dir> in NPATH.
+    lsd                     list dirs in NPATH (empty dirs too).
+    rm [-f|--force] <file>  remove notes or directories.
+    i, info [<file>]        print info about notes and configuration.
+    -h, --help              print this help message and exit.
+    -v, --version           print version and exit.
+
+Examples:
+
+Take a new note or open existing note:
+    n! [<note>]
+Take new note in 'work' directory:
+    n! work/my_note
+
+Environment:
+
+n! uses user's default editor. You can specify editor in EDITOR environment
+variable in your .bashrc or .bash_profile, or select default editor by 'select-editor'
+command.
+
+Also you can set specific editor for nexclamation in ~/.nexclamation file. For example:
+    NEDITOR=/usr/bin/vim.tiny
+
+Other configuration options:
+    NPATH           path to save notes. Default: /home/gd/.local/share/nexclamation/notes
+    NQNOTENAME      default file name for quick notes. Default: NOTE
+

To create new note just run n! or:

+
n! note.md
+ + diff --git a/README.md b/README.md index 015138f..b87f241 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,44 @@ make uninstall # Usage +``` +Usage: n! [-v|--version] [-h|--help] [] [...] + +Commands and options: + q, quick [] take a quick note in current directory. + s, search search in notes via grep. + l, last open last opened file in editor. + mkdir add new directory. Creates new dir in NPATH. + ls [] list all notes, or notes from in NPATH. + lsd list dirs in NPATH (empty dirs too). + rm [-f|--force] remove notes or directories. + i, info [] print info about notes and configuration. + -h, --help print this help message and exit. + -v, --version print version and exit. + +Examples: + +Take a new note or open existing note: + n! [] +Take new note in 'work' directory: + n! work/my_note + +Environment: + +n! uses user's default editor. You can specify editor in EDITOR environment +variable in your .bashrc or .bash_profile, or select default editor by 'select-editor' +command. + +Also you can set specific editor for nexclamation in ~/.nexclamation file. For example: + NEDITOR=/usr/bin/vim.tiny + +Other configuration options: + NPATH path to save notes. Default: /home/gd/.local/share/nexclamation/notes + NQNOTENAME default file name for quick notes. Default: NOTE +``` + To create new note just run `n!` or: ``` n! note.md ``` - -See more help at: - -``` -n! --help -``` - -If you're having trouble using an exclamation mark in a command name, use command `nexclamation` instead of `n!`.