Skip to content

Commit 0fecb69

Browse files
committed
Update README with development instructions
- Markdown formattings - Add Development instructions
1 parent 8ef88e2 commit 0fecb69

File tree

1 file changed

+45
-18
lines changed

1 file changed

+45
-18
lines changed

README.md

+45-18
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,59 @@ to put comments in your code and then have them annotated across your whole proj
33

44
### Installation:
55

6-
7-
npm install notes -g
6+
```sh
7+
$ npm install notes -g
8+
```
89

910
### Usage:
1011

11-
$ notes # will search for notes in cwd
12-
$ notes lib/ test/ # will search only in lib and test
12+
```sh
13+
$ notes # will search for notes in cwd
14+
$ notes lib/ test/ # will search only in lib and test
15+
```
1316

1417
### What It Does:
1518

1619
For example, if a file contained these lines somewhere in it:
1720

18-
code...
19-
# NOTE: This line should get annoated by Notes.
20-
# OPTIMIZE Make things faster!
21-
22-
more code...
23-
# TODO: Annotate your tasks.
24-
25-
yet more code...
26-
# FIXME: Keep up with things to fix.
21+
```text
22+
code...
23+
# NOTE: This line should get annoated by Notes.
24+
# OPTIMIZE Make things faster!
25+
26+
more code...
27+
# TODO: Annotate your tasks.
28+
29+
yet more code...
30+
# FIXME: Keep up with things to fix.
31+
```
2732

2833
Those comments would be annotated as:
2934

30-
* /path/to/my/file
31-
Line 8: ✐ NOTE This line should get annoated by Notes.
32-
Line 9: ↘ OPTIMIZE Make things faster!
33-
Line 10: ✓ TODO Annotate your tasks.
34-
Line 11: ☂ FIXME Keep up with things to fix.
35+
```text
36+
* /path/to/my/file
37+
Line 8: ✐ NOTE This line should get annoated by Notes.
38+
Line 9: ↘ OPTIMIZE Make things faster!
39+
Line 10: ✓ TODO Annotate your tasks.
40+
Line 11: ☂ FIXME Keep up with things to fix.
41+
```
42+
43+
### Development:
44+
45+
#### Build Project
46+
47+
```sh
48+
$ npm install # install all dependencies
49+
50+
$ npm run -s build # build the project
51+
# OR
52+
$ npm i -g nodemon # install nodemon globally
53+
$ npm run -s build:watch # watch src/ dir for changes
54+
```
55+
56+
#### Test the Project
57+
58+
```sh
59+
$ npm link # make globally available
60+
$ notes # use the `notes` app
61+
```

0 commit comments

Comments
 (0)