added section on uninstalling in README.md

made the README more understandable
This commit is contained in:
Pranav Jerry 2021-05-11 12:27:58 +05:30
parent 671e58c7c3
commit e5f0f4da94

View File

@ -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