Skip to content

Commit 91bd472

Browse files
committed
updated docs
1 parent de590d7 commit 91bd472

File tree

5 files changed

+23
-8
lines changed

5 files changed

+23
-8
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,16 @@ Please add sufficient description to the comments of the pull request
1717
to describe the additional feature(s) added.
1818

1919
For each feature added the documentation will need to be amended as
20-
needed including the README.md file, the man pages in docs/* and where
20+
needed including the README.md file, the man pages in docs/ and where
2121
necessary the other documentation files in the root directory of the
2222
repo.
2323

2424

2525
## DOCUMENTATION PULL REQUESTS
2626

2727
Please run the aspell(1) spelling checker and the diction(1) grammar
28-
checker on any documentation changed.
28+
checker on any documentation changed and taking any appropriate advice
29+
given:
2930

3031
$ aspell -c <filename>
3132

@@ -49,3 +50,9 @@ considered by the author for inclusion. This list is NOT exhaustive
4950
and contributors should feel free to propose and code for additional
5051
features not on the ROADMAP.
5152

53+
You may propose features at the GitHub page by raising a feature
54+
request issues:
55+
56+
https://github.com/Standard-Unix-Notes/unix-notes/issues
57+
58+
Upon agreement they will be added to the ROADMAP file.

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,6 @@ This command decrypts each file in turn to STDOUT and greps for
262262
"licence plate" in the output.
263263

264264

265-
266265
### Sub-command delete | rm
267266

268267
To delete a note simply issue the command:

RELEASE-NOTES.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1-
STANDARD (?) UNIX NOTES
1+
# STANDARD(?) UNIX NOTES
2+
3+
# RELEASE NOTES
24

3-
x.y SECOND RELEASE
5+
1.5 SECOND RELEASE
46
- Fully expanded README.md giving base documentation
7+
- Search functionality added
58
- Updated project documentation to markdown (excluding
69
man pages)
710
- makefiles now get $(VER) from GIT TAG

SECURITY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ We support the following versions of this application:
66

77
| Version | Supported |
88
| ------- | ------------------ |
9+
| 1.5 | :white_check_mark: |
910
| 1.0 | :white_check_mark: |
1011

1112

docs/notes.1

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,14 @@ EVIL MASTER PLAN
279279
Notes supports all hardware devices that GnuPG supports. This includes
280280
the following Yubico devices:
281281

282-
- Yubikey 5 Series (including FIPS models)
283-
- Yubikey 4 Series (including FIPS models)
284-
- Yubikey NEO
282+
.RS
283+
.IP \(em 2
284+
Yubikey 5 Series (including FIPS models)
285+
.IP \(em 2
286+
Yubikey 4 Series (including FIPS models)
287+
.IP \(em 2
288+
Yubikey NEO
289+
.RE
285290

286291
A good guide for using GnuPG with Yubikeys can be found at
287292
.UR https://github.com/drduh/YubiKey-Guide

0 commit comments

Comments
 (0)