diff --git a/README.md b/README.md index 89f4c5f..4ff3faf 100644 --- a/README.md +++ b/README.md @@ -11,41 +11,53 @@ West Bengal. ## Requirements -* systemd v248 or more -* Linux kernel (batman-adv only works on Linux) -* iwd +* systemd v248 or more (for batman support) +* Linux kernel with batman-adv module (if `modinfo batman-adv` shows no error + then you already have it) +* iwd (for starting ad-hoc network) * 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 -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 ``` 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 - add support for wireless ap (WiFi hotspot)