commented out some parts in README

added info about new branch
This commit is contained in:
Pranav Jerry 2021-05-21 20:18:49 +05:30
parent e1fe05b280
commit a2129e40e5

View File

@ -8,11 +8,13 @@ you can only communicate with other peers running the same software.
The name naxal comes from Naxalbari, a village in Darjeeling, The name naxal comes from Naxalbari, a village in Darjeeling,
West Bengal. West Bengal.
A rewrite in python is in progress in the branch python-rewrite.
<!-- UNCOMMENT WHEN NECESSARY <!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**: **Disclaimer**:
In case you are either 1) a complete idiot; or 2) a member of parliament in In case you are either 1) a complete idiot; or 2) a member of parliament;
India; or 3) both, please be aware that this project is not affiliated with or 3) both, please be aware that this project is not affiliated with
any groups designated as terrorist groups in India. any groups designated as terrorist groups in India.
Using the name Naxal does not imply any form of connection Using the name Naxal does not imply any form of connection
@ -37,12 +39,12 @@ and others which can work without internet access.
## Requirements ## Requirements
* systemd v248 or more (for batman support) - systemd v248 or more (for batman support)
* Linux kernel with batman-adv module (if `modinfo batman-adv` shows no error - Linux kernel with batman-adv module (if `modinfo batman-adv` shows no error
then you already have it) then you already have it)
* iwd (for starting ad-hoc network) - iwd (for starting ad-hoc network)
* wifi adapter with ad-hoc support - wifi adapter with ad-hoc support
* two or more computers with wifi adapter - two or more computers with wifi adapter
## Installing ## Installing
@ -53,6 +55,7 @@ Clone the repo and cd into it.
Run `sudo make install` to install naxalnet. This will install naxalnet in Run `sudo make install` to install naxalnet. This will install naxalnet in
`/usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}`. `/usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}`.
<!-- commented out as you'll have to edit the systemd service for this to work
To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`. To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`.
After installing, reload systemd so that you can enable `naxalnet@.service` After installing, reload systemd so that you can enable `naxalnet@.service`
@ -68,7 +71,7 @@ Any network managers such as NetworkManager and wifi daemons like
wpa_supplicant should be disabled: wpa_supplicant should be disabled:
``` ```
sudo systemctl disable --now NetworkManager wpa_supplicant sudo systemctl disable --now NetworkManager
``` ```
Enable the naxalnet service on the device `wlan0` (iwd replaces interface Enable the naxalnet service on the device `wlan0` (iwd replaces interface
@ -85,10 +88,12 @@ the files:
``` ```
sudo rm -r /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service} sudo rm -r /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
``` ```
<!--
Or if you installed naxalnet in /usr/local: Or if you installed naxalnet in /usr/local:
``` ```
sudo rm -r /usr/local/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service} sudo rm -r /usr/local/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
``` ```
-->
## TODO ## TODO