pybatmesh/HACKING.md

# Hacking

Everyone can [hack][] naxalnet. See below for how to hack.

## Questions and answers

Join the XMPP channel <xmpp:naxalnet@chat.disroot.org> to talk about
anything related to this program or about mesh networks in general.

<!-- And send your hate to /dev/null -->

## Reporting issues and suggesting ideas

To report a bug or suggest an idea, create a new issue at
<https://git.disroot.org/pranav/naxalnet/issues>

While reporting a bug, you can add the debug messages to provide more
data. Run `journalctl -fu naxalnet` on a terminal emulator (this could
take some time on some machines). Now on another one, type `sudo systemctl start naxalnet.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
`naxalnet/__init__.py`

## Packaging

Currently this program is only packaged for Arch Linux. naxalnet 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
added HACKING.md 2021-07-02 09:30:28 +05:30			`# Hacking`

made README and HACKING.md more readable 2021-08-13 11:32:42 +05:30			`Everyone can [hack][] naxalnet. See below for how to hack.`
Updated HACKING.md and naxalnet/iwd.py Added Device.reload() to reload the proxy every time the device mode is changed. Added Device.set_mode() and partial implementation of Device.start_adhoc_open(). Added link to meaning of hack in HACKING.md 2021-07-07 14:08:05 +05:30
removed all print() calls from network.py Updated CHANGELOG.md. We (another word for 'me') can push after moving naxalnet.service out of service/. I am told the unit file is having a rather dull time coping with per lonely life. 2021-12-01 21:27:27 +05:30			`## Questions and answers`
add xmpp channel to README.md and HACKING.md 2021-10-31 20:18:56 +05:30
			`Join the XMPP channel <xmpp:naxalnet@chat.disroot.org> to talk about`
			`anything related to this program or about mesh networks in general.`

new version -- 0.5.2 2021-12-10 20:16:34 +05:30			`<!-- And send your hate to /dev/null -->`

Updated HACKING.md and naxalnet/iwd.py Added Device.reload() to reload the proxy every time the device mode is changed. Added Device.set_mode() and partial implementation of Device.start_adhoc_open(). Added link to meaning of hack in HACKING.md 2021-07-07 14:08:05 +05:30			`## Reporting issues and suggesting ideas`
added HACKING.md 2021-07-02 09:30:28 +05:30
			`To report a bug or suggest an idea, create a new issue at`
turn off all wifi devices at exit This makes things easier to maintain, or so I hope. Added more comments in files in systemd-networkd, made CHANGELOG.md better, and updated the README. 2021-09-29 15:14:13 +05:30			`<https://git.disroot.org/pranav/naxalnet/issues>`
added HACKING.md 2021-07-02 09:30:28 +05:30
removed all print() calls from network.py Updated CHANGELOG.md. We (another word for 'me') can push after moving naxalnet.service out of service/. I am told the unit file is having a rather dull time coping with per lonely life. 2021-12-01 21:27:27 +05:30			`While reporting a bug, you can add the debug messages to provide more`
			data. Run `journalctl -fu naxalnet` on a terminal emulator (this could
			take some time on some machines). Now on another one, type `sudo systemctl start naxalnet.service` or whatever caused the error. Now copy the error
			`messages and paste it in the issue body along with the description.`
added features section in README.md And added some more info on adding bug reports. See issue #20. 2021-10-15 16:05:06 +05:30
made README and HACKING.md more readable 2021-08-13 11:32:42 +05:30			`## Improving documentation`
added new section in HACKING.md 2021-08-02 16:05:24 +05:30
removed all print() calls from network.py Updated CHANGELOG.md. We (another word for 'me') can push after moving naxalnet.service out of service/. I am told the unit file is having a rather dull time coping with per lonely life. 2021-12-01 21:27:27 +05:30			`The README and HACKING.md needs to be more beginner friendly. See #20.`
added new section in HACKING.md 2021-08-02 16:05:24 +05:30
added HACKING.md 2021-07-02 09:30:28 +05:30			`## Contribute code`

removed all print() calls from network.py Updated CHANGELOG.md. We (another word for 'me') can push after moving naxalnet.service out of service/. I am told the unit file is having a rather dull time coping with per lonely life. 2021-12-01 21:27:27 +05:30			`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
			`naxalnet/__init__.py`
added HACKING.md 2021-07-02 09:30:28 +05:30
			`## Packaging`

removed all print() calls from network.py Updated CHANGELOG.md. We (another word for 'me') can push after moving naxalnet.service out of service/. I am told the unit file is having a rather dull time coping with per lonely life. 2021-12-01 21:27:27 +05:30			`Currently this program is only packaged for Arch Linux. naxalnet 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.`
Updated HACKING.md and naxalnet/iwd.py Added Device.reload() to reload the proxy every time the device mode is changed. Added Device.set_mode() and partial implementation of Device.start_adhoc_open(). Added link to meaning of hack in HACKING.md 2021-07-07 14:08:05 +05:30
			`[hack]: https://catb.org/jargon/html/H/hack.html`