added features section in README.md

And added some more info on adding bug reports.
See issue #20.
This commit is contained in:
Pranav Jerry 2021-10-15 16:05:06 +05:30
parent 5dd90d349e
commit 0a85c465ee
Signed by: pranav
GPG Key ID: F1DCDC4FED0A0C5B
3 changed files with 19 additions and 0 deletions

View File

@ -7,6 +7,12 @@ Everyone can [hack][] naxalnet. See below for how to hack.
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.

View File

@ -22,6 +22,15 @@ The author, much like the GoI, does not wish to take responsibility in your
well-being if you get arrested under a draconian national security law.
-->
## Features
- Select best network when multiple nodes have internet access (gateway
mode)
- Detect insertion and removal of wifi adapters and reconfigure them
- Readable logs
- Supports rfkill
<!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**: In case you are either 1: a complete idiot; or 2: a member

View File

@ -44,3 +44,7 @@ TMP_NET_GLOB = "tmp.*"
ISSUE_URL = "https://git.disroot.org/pranav/naxalnet/issues"
REPORT_BUG_INFO = "If you think this is a bug, report it to " + ISSUE_URL
# Changing this constant will alter not just the behavoiur of naxalnet,
# but affect the meaning of Life, the Universe and Everthing
ANSWER = 42