pybatmesh/HACKING.md

# Hacking

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

## Questions, answers and hate speech

Join the XMPP channel <xmpp:naxalnet@chat.disroot.org> to talk about
anything related to this program or about mesh networks in general.
Redirect your hate messages 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 need to add the debug messages too. Run
`journalctl -fu naxalnet` on a terminal emulator (this could take some
time). 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 06:00:28 +02:00			`# Hacking`

made README and HACKING.md more readable 2021-08-13 08:02:42 +02:00			`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 10:38:05 +02:00
add xmpp channel to README.md and HACKING.md 2021-10-31 15:48:56 +01:00			`## Questions, answers and hate speech`

			`Join the XMPP channel <xmpp:naxalnet@chat.disroot.org> to talk about`
			`anything related to this program or about mesh networks in general.`
			Redirect your hate messages 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 10:38:05 +02:00			`## Reporting issues and suggesting ideas`
added HACKING.md 2021-07-02 06:00:28 +02:00
			`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 11:44:13 +02:00			`<https://git.disroot.org/pranav/naxalnet/issues>`
added HACKING.md 2021-07-02 06:00:28 +02:00
added features section in README.md And added some more info on adding bug reports. See issue #20. 2021-10-15 12:35:06 +02:00			`While reporting a bug, you need to add the debug messages too. Run`
			`journalctl -fu naxalnet` on a terminal emulator (this could take some
			time). 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.`

made README and HACKING.md more readable 2021-08-13 08:02:42 +02:00			`## Improving documentation`
added new section in HACKING.md 2021-08-02 12:35:24 +02:00
almost ready for merge * Improved CHANGELOG, README, HACKING * Added naxalnet.conf containing default values. This will be installed along with the package. 2021-08-15 11:32:28 +02:00			`The README and HACKING.md needs to be more beginner friendly.`
improved documentation 2021-10-08 18:58:01 +02:00			`See #20.`
added new section in HACKING.md 2021-08-02 12:35:24 +02:00
added HACKING.md 2021-07-02 06:00:28 +02:00			`## Contribute code`

			`To push to this repo, you need your username to be in the`
almost ready for merge * Improved CHANGELOG, README, HACKING * Added naxalnet.conf containing default values. This will be installed along with the package. 2021-08-15 11:32:28 +02:00			`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 06:00:28 +02:00
			`## Packaging`

almost ready for merge * Improved CHANGELOG, README, HACKING * Added naxalnet.conf containing default values. This will be installed along with the package. 2021-08-15 11:32:28 +02:00			`Currently this program is only packaged for Arch Linux.`
			`naxalnet needs packages in GNU+Linux+systemd`
			`distributions such as Debian, Fedora, openSUSE,`
Fixed another typo in HACKING.md 2021-07-18 16:35:39 +02:00			`and nixos. If you know/like to package it in your distro,`
updated documentation and some other changes Made messages printed in Makefile more understandable. Removed full path of naxalnet from the systemd service. Now you can start naxalnet even if it is installed in /usr/local/bin, if systemd allows (I have not tested it). Many comments were made to respect the 80 chars per line rule. And, of course, added some political commentary to insult the global superpower (superpower in terms of money, military and something else I forgot). And removed MANIFEST.in, which probably haven't changed anything. 2021-10-02 10:43:53 +02:00			`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 10:38:05 +02:00
			`[hack]: https://catb.org/jargon/html/H/hack.html`