From f9c969d23351666256623dfbb5af5376840daa1a Mon Sep 17 00:00:00 2001 From: Pranav Jerry Date: Wed, 8 Sep 2021 15:52:14 +0530 Subject: [PATCH] updated README.md Now that naxalnet is a daemon, there was some things which didn't make sense anymore. So they were removed. --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 26201d5..d947b2d 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,7 @@ You need more than one machine running naxalnet for the connection to work. ### Start naxalnet -Though naxalnet can run from the commandline, it was designed to be +Though naxalnet can run from the command line, it was designed to be run as a systemd service. To start naxalnet, do the command on all the nodes: @@ -163,25 +163,25 @@ sudo systemctl start naxalnet.service This will start a mesh network and connect to all nodes. To test if it works, run `sudo batctl n -w` and check for -nodes. If there are any nodes, your network is up. +nodes. If there are any nodes, your network is up. Press +Ctrl+C to stop `batctl`. ### Getting internet access -Connect an ethernet cable from a router to any of the peers and -[start naxalnet][startnx]. If it was already started, you should +Connect an ethernet cable from a router to any of the nodes and renew the DHCP connection of all peers. To do this, type -`sudo networkctl renew bridge0` on all peers. +`sudo networkctl renew bridge0` on all nodes. ### Tethering via WiFi AP If there are two adapters in a peer, naxalnet will start a 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 started on one of the adapters. +Connect two WiFi adapters on a node. +Now an AP will be started on one of the adapters. Type `naxalnet --print-wifi` to get the WiFi SSID and password. -If you had set up internet access on one of the peers, internet +If you had set up internet access on one of the nodes, internet can be accessed from the AP. ### Running at boot @@ -246,7 +246,7 @@ 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 and the documentation to learn the details. +Read the code and the documentation in the code to learn the details. See the directory [systemd-networkd](systemd-networkd) to see how systemd-networkd configures the network. @@ -295,13 +295,13 @@ See [HACKING.md](HACKING.md) Many projects make setting up B.A.T.M.A.N. Advanced mesh networks with WiFi routers easier. They are easier to setup and are more configurable. But naxalnet is different from them. It simplifies -setting up mesh networks with _laptops or computers_, and is not -designed to work with routers. +setting up mesh networks with _laptops or computers_, and was not +made to work with routers. The following projects does something similar to naxalnet, but requires special devices or routers to work. If you live in an area -where the materials required for any of them are easily available, -consider using them instead of naxalnet. +where the materials are easily available, consider using them instead +of naxalnet. - [LibreMesh][]: framework for OpenWrt-based firmwares - [disaster.radio][]: solar-powered communications network