Skip to content

Commit bbdce2d

Browse files
author
theindigamer
committed
Add some more docs for GitHub.
1 parent 40327c5 commit bbdce2d

File tree

3 files changed

+62
-5
lines changed

3 files changed

+62
-5
lines changed

.github/ISSUE_TEMPLATE.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[This is a template. Please delete irrelevant sections, including this line,
2+
before posting.]
3+
4+
## Feature request
5+
6+
* Short description (2-3 lines)
7+
8+
* Long description (optional)
9+
10+
* Suggested test cases, if any
11+
12+
## Bug report
13+
14+
- `ozil` version (git commit):
15+
16+
(Fill in a checkbox with an X instead of a blank.)
17+
18+
- Issue type
19+
+ [ ] Unexpected crash
20+
- Error message: [description here]
21+
+ [ ] Improper rendering
22+
- [ ] Present with wide terminals (e.g. full screen-width)
23+
- [ ] Present with narrow terminals (e.g. half screen-width)
24+
- [ ] Present with very narrow terminals (e.g. quarter screen-width)
25+
+ [ ] Something else: [description here]
26+
27+
- Test cases for reproduction (1 or more):
28+
29+
- Screenshots (0 or more):

Contributing.md

+24
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,30 @@
11
# Contributing
22

3+
## Patches
4+
5+
* No contribution is too small. Even if it is a typo fix, please submit it!
6+
7+
* Before you start working on something, please open an issue on the issue
8+
tracker for it, or leave a comment on an existing issue.
9+
10+
Similarly, if you need help (while trying to write a patch), or have become
11+
busy with other commitments (and hence will not be able to contribute) while
12+
working on an issue, please leave a comment. Both of these are perfectly
13+
understandable situations, and I will try to help if I'm able to do so.
14+
15+
* Try to follow the conventions (e.g. naming, formatting, how imports are
16+
organized) of the surrounding code.
17+
18+
* Force-pushing to pull request branches is perfectly okay. Not having a clean
19+
git history is perfectly okay too. Don't sweat it.
20+
321
# Development notes
422

523
* Use the incantation `rg "\\\\[^ -]+" man.1 -N -o | sort | uniq` to obtain
624
the list of escape codes under use in `man.1`.
25+
* To see list of directives at line-start across all man files -
26+
```
27+
cd /usr/share/man
28+
for f in ./*/*.gz; do gunzip --stdout "$f"; done \
29+
| rg "^\\.[[:alpha:]]{1,2}" -o -U | sort | uniq -c
30+
```

Readme.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
`ozil` assists you with viewing man/help pages. It is intended as a
44
porcelain for `man`/`--help` + `less`/`more`/`most`.
55

6-
[Note: Support for man pages is not yet ready.]
6+
[Note: Support for man pages is not yet ready. If you try to read a man page,
7+
`ozil` might crash or display something weird.]
78

89
## Table of contents
910

@@ -45,9 +46,11 @@ porcelain for `man`/`--help` + `less`/`more`/`most`.
4546

4647
### Planned
4748

48-
- Basic options to customize appearance (with hot-reloading).
49-
- Proper man page support (fill remain check-boxes in Feature list).
50-
- Search text (see [issue 10](https://github.com/theindigamer/ozil/issues/10)).
49+
- Proper man page support (fill remain check-boxes in Feature list). Given the
50+
variety of macros present in man pages, this is a big task, so please have
51+
some patience. :sweat_smile:
52+
- Basic options to customize appearance (with hot-reloading).
53+
- Search text (see [issue 10](https://github.com/theindigamer/ozil/issues/10)).
5154

5255
## Platforms
5356

@@ -83,7 +86,8 @@ see the help for `foo bar` (where `bar` is a subcommand of `foo`) run
8386
`ozil 'foo bar'`.
8487

8588
If you're want a man page from a specific section (e.g. `man(1)`), you
86-
can use `ozil man.1`.
89+
can use `ozil man.1` (Note: This might still crash as documented at the
90+
beginning of the Readme).
8791

8892
That's mostly it. `ozil` will guide you as needed. In case of
8993
ambiguities, it will present you with an option to make a choice and

0 commit comments

Comments
 (0)