updated README

This commit is contained in:
Pranav Jerry 2021-05-11 12:16:32 +05:30
parent 8d318a5b13
commit 671e58c7c3

View File

@ -11,41 +11,53 @@ West Bengal.
<!-- UNCOMMENT WHEN NECESSARY <!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**: **Disclaimer**:
In case you are either 1) a complete idiot; or 2) the prime minister of India; In case you are either 1) a complete idiot; or 2) a member of parliament in
or 3) both, please be aware that this project is not affiliated with India; 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
with anyone the government collectively calles Urban Naxals (human rights with anyone the government collectively calles Urban Naxals (human rights
activists, lawyers, poets, writers, journalists or anyone else activists, lawyers, poets, writers, journalists or anyone else
advocating the proper implementaion of constitutional or universal rights). advocating the constitutional rights).
--> -->
## Requirements ## Requirements
* systemd v248 or more * systemd v248 or more (for batman support)
* Linux kernel (batman-adv only works on Linux) * Linux kernel with batman-adv module (if `modinfo batman-adv` shows no error
* iwd then you already have it)
* 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
Any network managers such as NetworkManager should be disabled: Any network managers such as NetworkManager and wifi daemons like
wpa_supplicant should be disabled:
``` ```
sudo systemctl disable --now NetworkManager sudo systemctl disable --now NetworkManager wpa_supplicant
``` ```
## Installing ## Installing
Run `make install` to install naxalnet. Run `sudo make install` to install naxalnet.
This will install the naxalnet interface
in `/usr/{bin,share/naxalnet,lib/systemd/system}`.
Enable the naxalnet service on the device `wlan0`: To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`.
Now enable the naxalnet service on the device `wlan0` (iwd replaces interface
names like wlp1s0 with wlan0):
``` ```
sudo systemctl enable naxalnet@wlan0.service sudo systemctl enable naxalnet@wlan0.service
``` ```
Now naxalnet will configure a batman interface on every boot. Now naxalnet will configure a batman interface on every boot.
## Uninstalling
Currently there is now way to uninstall naxalnet than to manually removing
the files.
## TODO ## TODO
- add support for wireless ap (WiFi hotspot) - add support for wireless ap (WiFi hotspot)