upd README
This commit is contained in:
parent
ea846e9386
commit
6c6a8b2343
|
|
@ -0,0 +1,212 @@
|
|||
<!DOCTYPE html>
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="generator" content="pandoc" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||||
<title>README</title>
|
||||
<style>
|
||||
html {
|
||||
line-height: 1.5;
|
||||
font-family: Georgia, serif;
|
||||
font-size: 20px;
|
||||
color: #1a1a1a;
|
||||
background-color: #fdfdfd;
|
||||
}
|
||||
body {
|
||||
margin: 0 auto;
|
||||
max-width: 36em;
|
||||
padding-left: 50px;
|
||||
padding-right: 50px;
|
||||
padding-top: 50px;
|
||||
padding-bottom: 50px;
|
||||
hyphens: auto;
|
||||
overflow-wrap: break-word;
|
||||
text-rendering: optimizeLegibility;
|
||||
font-kerning: normal;
|
||||
}
|
||||
@media (max-width: 600px) {
|
||||
body {
|
||||
font-size: 0.9em;
|
||||
padding: 1em;
|
||||
}
|
||||
h1 {
|
||||
font-size: 1.8em;
|
||||
}
|
||||
}
|
||||
@media print {
|
||||
body {
|
||||
background-color: transparent;
|
||||
color: black;
|
||||
font-size: 12pt;
|
||||
}
|
||||
p, h2, h3 {
|
||||
orphans: 3;
|
||||
widows: 3;
|
||||
}
|
||||
h2, h3, h4 {
|
||||
page-break-after: avoid;
|
||||
}
|
||||
}
|
||||
p {
|
||||
margin: 1em 0;
|
||||
}
|
||||
a {
|
||||
color: [HTML]{0000ff};
|
||||
}
|
||||
a:visited {
|
||||
color: [HTML]{0000ff};
|
||||
}
|
||||
img {
|
||||
max-width: 100%;
|
||||
}
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
margin-top: 1.4em;
|
||||
}
|
||||
h5, h6 {
|
||||
font-size: 1em;
|
||||
font-style: italic;
|
||||
}
|
||||
h6 {
|
||||
font-weight: normal;
|
||||
}
|
||||
ol, ul {
|
||||
padding-left: 1.7em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
li > ol, li > ul {
|
||||
margin-top: 0;
|
||||
}
|
||||
blockquote {
|
||||
margin: 1em 0 1em 1.7em;
|
||||
padding-left: 1em;
|
||||
border-left: 2px solid #e6e6e6;
|
||||
color: #606060;
|
||||
}
|
||||
code {
|
||||
font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
|
||||
font-size: 85%;
|
||||
margin: 0;
|
||||
}
|
||||
pre {
|
||||
margin: 1em 0;
|
||||
overflow: auto;
|
||||
}
|
||||
pre code {
|
||||
padding: 0;
|
||||
overflow: visible;
|
||||
overflow-wrap: normal;
|
||||
}
|
||||
.sourceCode {
|
||||
background-color: transparent;
|
||||
overflow: visible;
|
||||
}
|
||||
hr {
|
||||
background-color: #1a1a1a;
|
||||
border: none;
|
||||
height: 1px;
|
||||
margin: 1em 0;
|
||||
}
|
||||
table {
|
||||
margin: 1em 0;
|
||||
border-collapse: collapse;
|
||||
width: 100%;
|
||||
overflow-x: auto;
|
||||
display: block;
|
||||
font-variant-numeric: lining-nums tabular-nums;
|
||||
}
|
||||
table caption {
|
||||
margin-bottom: 0.75em;
|
||||
}
|
||||
tbody {
|
||||
margin-top: 0.5em;
|
||||
border-top: 1px solid #1a1a1a;
|
||||
border-bottom: 1px solid #1a1a1a;
|
||||
}
|
||||
th {
|
||||
border-top: 1px solid #1a1a1a;
|
||||
padding: 0.25em 0.5em 0.25em 0.5em;
|
||||
}
|
||||
td {
|
||||
padding: 0.125em 0.5em 0.25em 0.5em;
|
||||
}
|
||||
header {
|
||||
margin-bottom: 4em;
|
||||
text-align: center;
|
||||
}
|
||||
#TOC li {
|
||||
list-style: none;
|
||||
}
|
||||
#TOC ul {
|
||||
padding-left: 1.3em;
|
||||
}
|
||||
#TOC > ul {
|
||||
padding-left: 0;
|
||||
}
|
||||
#TOC a:not(:hover) {
|
||||
text-decoration: none;
|
||||
}
|
||||
code{white-space: pre-wrap;}
|
||||
span.smallcaps{font-variant: small-caps;}
|
||||
span.underline{text-decoration: underline;}
|
||||
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
||||
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
|
||||
ul.task-list{list-style: none;}
|
||||
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
|
||||
</style>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
|
||||
<![endif]-->
|
||||
</head>
|
||||
<body>
|
||||
<header id="title-block-header">
|
||||
<h1 class="title">README</h1>
|
||||
</header>
|
||||
<h1 id="n">n!</h1>
|
||||
<p><strong>n!</strong> is shell powered note taking tool. Notes are
|
||||
stored locally in <code>$HOME/.local/nexclamation/notes</code> by
|
||||
default as plain text.</p>
|
||||
<p><strong>n!</strong> depends on Bash, GNU coreutils, find, sed, awk.
|
||||
Usually these programs are already installed on most Linux distros.</p>
|
||||
<h1 id="installation">Installation</h1>
|
||||
<pre><code>make install</code></pre>
|
||||
<p>Uninstall by:</p>
|
||||
<pre><code>make uninstall</code></pre>
|
||||
<h1 id="usage">Usage</h1>
|
||||
<pre><code>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</code></pre>
|
||||
<p>To create new note just run <code>n!</code> or:</p>
|
||||
<pre><code>n! note.md</code></pre>
|
||||
</body>
|
||||
</html>
|
||||
44
README.md
44
README.md
|
|
@ -18,16 +18,44 @@ 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
|
||||
```
|
||||
|
||||
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!`.
|
||||
|
|
|
|||
Loading…
Reference in New Issue