Skip to content

Commit

Permalink
chore(docs): update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hnicke committed Aug 4, 2021
1 parent 9063049 commit 42e51b7
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 22 deletions.
22 changes: 4 additions & 18 deletions docs/developer_guide.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,9 @@
# Developer Guide

This document is aimed towards developers who want to contribute to sodalite.
Please read this document of you are planning on contributing to `sodalite`.

#### Building the man page
Please add the supplied pre-commit hook:
#### Add git hooks
Please symlink the supplied git hooks:
```bash
bin/hooks/symlink-hooks
make setup-hooks
```
This will translate the markdown man page to the groff manpage, and stage the resulting file everytime you commit.

#### Code formatting
The project is auto-formatted with PyCharm (default settings).

### Release Checklist
##### before
- update changelog
- update VERSION variable in __main__.py
- new Dependencies? Update readme!
- push tag

##### after
- contact dev(at)heiko-nickerl.com and ask to update the aur packages
2 changes: 1 addition & 1 deletion docs/sodalite-open.1
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ retry launching the file with other applications
Please report at https://github.com/hnicke/sodalite/issues.
.SH AUTHOR
.PP
Heiko Nickerl <dev(at)heiko-nickerl.com>
Heiko Nickerl <dev(at)hnicke.de>
.SH SEE ALSO
.PP
\f[B]xdg-open(1)\f[R]
2 changes: 1 addition & 1 deletion docs/sodalite-open.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Please report at https://github.com/hnicke/sodalite/issues.
AUTHOR
======

Heiko Nickerl <dev(at)heiko-nickerl.com>
Heiko Nickerl <dev(at)hnicke.de>

SEE ALSO
========
Expand Down
2 changes: 1 addition & 1 deletion docs/sodalite.1
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ If \f[C]$XDG_DATA_HOME\f[R] is not set, uses
Please report at https://github.com/hnicke/sodalite/issues.
.SH AUTHOR
.PP
Heiko Nickerl <dev(at)heiko-nickerl.com>
Heiko Nickerl <dev(at)hnicke.de>
.SH SEE ALSO
.PP
\f[B]sodalite-open\f[R]
2 changes: 1 addition & 1 deletion docs/sodalite.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ Please report at https://github.com/hnicke/sodalite/issues.
AUTHOR
======

Heiko Nickerl <dev(at)heiko-nickerl.com>
Heiko Nickerl <dev(at)hnicke.de>

SEE ALSO
========
Expand Down

0 comments on commit 42e51b7

Please sign in to comment.