diff --git a/HACKING.md b/HACKING.md index 8495bb9..bf8780c 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,7 +1,6 @@ # Hacking -Everyone -is welcome to [hack][] naxalnet. See below for how to hack. +Everyone can [hack][] naxalnet. See below for how to hack. ## Reporting issues and suggesting ideas @@ -9,14 +8,15 @@ To report a bug or suggest an idea, create a new issue at with a relevant label. -## Improving documentaion +## Improving documentation See section below ## Contribute code To push to this repo, you need your username to be in the -contributors list. See issue #8. +contributors list. See issue #8. Before each commit, update +the CHANGELOG and `__version__` in `naxalnet/__init__.py` ## Packaging diff --git a/README.md b/README.md index 271c571..f7edeaf 100644 --- a/README.md +++ b/README.md @@ -111,18 +111,18 @@ from DHCP. ### Getting internet access Connect an ethernet cable to any of the peers and -[start naxalnet][startnx]. Now all the peers should -be able to connect after renewing their DHCP connection -(`sudo networkctl renew bridge0`). +[start naxalnet][startnx]. If it was already started, you should +renew the DHCP connection of all peers. To do this, type +`sudo networkctl renew bridge0` on all peers. ### Tethering via WiFi AP If there are two adapters in a peer, naxalnet will start a -wifi ap (wifi hotspot) on one of them. +wifi ap (also called wifi hotspot) on one of them. Connect two wifi adapters on a device and [start naxalnet][startnx]. -Now an ap will be created on one of the adapters with -SSID `NaxalNet` and password `naxalnet256`. +Now an ap will be created on one of the adapters. + If you had set up internet access on one of the peers, internet can be accessed from the AP. @@ -165,9 +165,17 @@ sudo systemctl start NetworkManager.service There are three modes commonly supported by wifi adapters - `ap` (wifi hotspot), `station` (for joining wifi networks) and `ad-hoc` -(for decentralised networks). +(for decentralised networks). There are some other modes too, +like `p2p` (wifi direct), but we won't go into the details. + +naxalnet uses two mode -- ad-hoc and ap, for connecting to the mesh. naxalnet uses iwd to start an `ad-hoc` network and configures systemd-networkd to setup a BATMAN Advanced network. +If there are two wifi adapters connected to the machine, +naxalnet starts an ad-hoc on one of them and an ap on the other. +You can use the ap for connecting mobile phones and other devices +to the mesh network. + Read the code to learn the details. See [systemd-networkd](systemd-networkd) to see how systemd-networkd configures the network. @@ -199,27 +207,26 @@ sudo pip uninstall naxalnet sudo rm -rf /usr/share/naxalnet* /usr/lib/systemd/system/naxalnet.service ``` -## Contributing +## Contributing or reporting bugs See [HACKING.md](HACKING.md) ## Similar projects The following projects are similar to naxalnet, but are not designed -to be used in a laptop or computer with wifi adapter. If you live in +to be used in a machine with wifi adapter. If you live in an area where the materials required for any of them are easily available, consider using them instead of naxalnet. -- [LibreMesh][libremesh]: framework for OpenWrt-based - firmwares +- [LibreMesh][]: framework for OpenWrt-based firmwares - [disaster.radio][]: solar-powered communications network ## License -naxalnet is [free/libre/swatantra][free-sw] software: you can -redistribute it and/or modify it under the terms of the GNU General -Public License as published by the Free Software Foundation, either -version 3 of the License, or (at your option) any later version. +naxalnet is [free/libre/swatantra][free-sw] and open source software; +you can redistribute it and/or modify it under the terms of the GNU +General Public License as published by the Free Software Foundation, +eitherversion 3 of the License, or (at your option) any later version. See [LICENSE](LICENSE) for the complete version of the license.