From e5f0f4da94344ad823acaedcd9ccfc1d9dd60df4 Mon Sep 17 00:00:00 2001 From: Pranav Jerry Date: Tue, 11 May 2021 12:27:58 +0530 Subject: [PATCH] added section on uninstalling in README.md made the README more understandable --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4ff3faf..a9ed187 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,23 @@ advocating the constitutional rights). * wifi adapter with ad-hoc support * two or more computers with wifi adapter +## Installing + +### Manually + +Run `sudo make install` to install naxalnet. This will install naxalnet in +`/usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}`. + +To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`. + +After installing, reload systemd so that you can enable `naxalnet@.service` +without rebooting: +``` +sudo systemctl daemon-reload +``` + +## Running the program + Any network managers such as NetworkManager and wifi daemons like wpa_supplicant should be disabled: @@ -38,25 +55,24 @@ wpa_supplicant should be disabled: sudo systemctl disable --now NetworkManager wpa_supplicant ``` -## Installing - -Run `sudo make install` to install naxalnet. -This will install the naxalnet interface -in `/usr/{bin,share/naxalnet,lib/systemd/system}`. - -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 +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 --now 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. +the files: +``` +sudo rm /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service} +``` +Or if you installed naxalnet in /usr/local: +``` +sudo rm /usr/local/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service} +``` ## TODO