You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,10 @@ notes
3
3
4
4
**notes** is a command line program that provides quick access, editing capability, and search functionality to all notes under a directory of your choosing. Under your notes directory, you can organize your notes into any folder structure you like.
5
5
6
-
The default extension for notes is `md`. The extension is not part of notes' syntax. **notes** supports **_tab completion_** and **_wildcard matching_** from any directory: the `*` wildcard is replaced by `@`.
6
+
The default extension for notes is `.md`. The extension is not part of notes' syntax. **notes** supports **_tab completion_** and **_wildcard matching_** from any directory: the `*` wildcard is replaced by `@`.
7
7
8
8
9
9
## Features
10
-
11
10
* Fast, natural syntax for manipulating notes **from any directory**
12
11
* Quickly find notes using tab completion
13
12
* Pass a note to any program, match notes using globbing patterns
@@ -18,6 +17,7 @@ The default extension for notes is `md`. The extension is not part of notes' syn
18
17
19
18
## Installation
20
19
20
+
21
21
#### OSX
22
22
```sh
23
23
brew tap kylebebak/tap
@@ -28,23 +28,26 @@ brew install notes
28
28
To make **notes** truly sweet, insert the following into your shell startup file (e.g. `.bash_profile`):
29
29
`which notes >/dev/null && . "$( notes -i )"`
30
30
31
+
31
32
#### Notes directory
32
33
The first time you run **notes**, you will be prompted to choose your notes directory. You need to use the **absolute path** to an existing directory. If you ever want to change it, run `notes -d <directory>`.
33
34
34
-
#### Other systems
35
35
36
-
Clone this repo, or download and unzip the [tarball](https://github.com/kylebebak/notes/archive/1.0.1.tar.gz). Either add the `bin` directory to your `$PATH`, or create a symlink in your `$PATH` that points to the **notes** executable in the `bin` directory.
36
+
#### Other systems
37
+
Clone this repo, or download and unzip the [tarball](https://github.com/kylebebak/notes/archive/1.1.0.tar.gz). Either add the `bin` directory to your `$PATH`, or create a symlink in your `$PATH` that points to the **notes** executable in the `bin` directory.
37
38
38
39
If you execute **notes** via symlink, *make sure that the name of the target file (the symlink) is also notes*. Otherwise, tab completions won't work.
39
40
40
41
41
42
## Extra
43
+
The default extension for notes is `.md`, because markdown is great. If you want to change it, edit the `_ext` variable in `_config/env.sh`.
42
44
43
-
* The default extension for notes is `md`, because markdown is great. If you want to change it, edit the `_ext` variable in `_config/env.sh`.
45
+
If you want to print your current config, and the absolute path to the config file, execute `notes -c`.
44
46
45
47
46
48
## Usage
47
49
50
+
48
51
#### Syntax
49
52
```
50
53
zero arguments : list all notes
@@ -54,6 +57,7 @@ two arguments <program> <glob_pattern>: pass all matched notes as ar
54
57
g.t. two arguments <program> <notes>: pass notes as arguments to program
55
58
```
56
59
60
+
57
61
#### Options
58
62
```
59
63
[ -n NEW_NOTE ] create and open a note
@@ -67,7 +71,7 @@ g.t. two arguments <program> <notes>: pass notes as arguments to p
67
71
[ -d DIR ] set notes directory (absolute path to existing directory)
68
72
```
69
73
70
-
Execute `notes -h` to get help and see more options.
74
+
Execute `notes -h` to get help and see more options, and `notes -v` to print the current version.
0 commit comments