Skip to content

Commit 3784efb

Browse files
committed
docs: Improved README and man page
1 parent 617d2e3 commit 3784efb

4 files changed

Lines changed: 406 additions & 245 deletions

File tree

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ watch:
1818

1919
test:
2020
@go test ./...
21+
22+
man:
23+
mdman -o ./docs/$(BINNAME).1 ./docs/$(BINNAME).1.md && man ./docs/$(BINNAME).1

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,10 @@ name = "bash"
160160
language-servers = [{ name = "bashd" }]
161161
```
162162

163+
See [bashd (1)](/docs/bashd.1.md) for all
164+
[configuration options](/docs/bashd.1.md#CONFIGURATION) and
165+
full [examples](/docs/bashd.1.md#EXAMPLES).
166+
163167
[sgr]: https://en.wikipedia.org/wiki/ANSI_escape_code#Select_Graphic_Rendition_parameters
164168
[8b-color]: https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
165169
[24b-color]: https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit

0 commit comments

Comments
 (0)