mirror of
https://git.disroot.org/pranav/pybatmesh.git
synced 2024-11-26 16:52:07 +05:30
Pranav Jerry
72dda12d7b
pybatmesh better describes the project and does not attract the attention of caged investigation agencies, like it probably would have before. I probably left traces of the original name somewhere, so this commit will likely be followed by other commits to erase all traces of the previous name
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
# Hacking
|
|
|
|
Everyone can [hack][] pybatmesh. See below for how to hack.
|
|
|
|
## Reporting issues and suggesting ideas
|
|
|
|
To report a bug or suggest an idea, create a new issue at
|
|
<https://git.disroot.org/pranav/pybatmesh/issues>
|
|
|
|
While reporting a bug, you can add the debug messages to provide more
|
|
data. Run `journalctl -fu pybatmesh` on a terminal emulator (this could
|
|
take some time on some machines). Now on another one, type `sudo systemctl start pybatmesh.service` or whatever caused the error. Now copy the error
|
|
messages and paste it in the issue body along with the description.
|
|
|
|
## Improving documentation
|
|
|
|
The README and HACKING.md needs to be more beginner friendly. See #20.
|
|
|
|
## Contribute code
|
|
|
|
To push to this repo, you need your username to be in the contributors
|
|
list. Add your username to issue #8 to add you as a contributor. Before
|
|
each commit, update the CHANGELOG.md and `__version__` in
|
|
`pybatmesh/__init__.py`
|
|
|
|
## Packaging
|
|
|
|
Currently this program is only packaged for Arch Linux. pybatmesh needs
|
|
packages in GNU+Linux+systemd distributions such as Debian, Fedora,
|
|
openSUSE, and nixos. If you know/like to package it in your distro, post a
|
|
message to issue #6.
|
|
|
|
[hack]: https://catb.org/jargon/html/H/hack.html
|