From 6acd7084f2424d623496d6814f823558eec31127 Mon Sep 17 00:00:00 2001 From: Pranav Jerry Date: Tue, 5 Oct 2021 12:06:50 +0530 Subject: [PATCH] made README better Added info on how to check requirements --- README.md | 54 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index a9cf7fe..8478590 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,11 @@ with anyone currently at risk of death in overcrowded prisons. ## Requirements -- [systemd-networkd v248 or more][batman-systemd] -- Linux kernel with batman-adv module +- [systemd-networkd v248 or greater][batman-systemd] +- Linux kernel with [batman-adv v2021.0][batman-systemd] or greater - [iwd][] for controlling the WiFi adapter -- python3 -- python3-setuptools, for building and installing naxalnet +- python (atleast 3.6) +- python setuptools, for building and installing naxalnet - [python-systemd][], for logging to systemd journal - [dasbus][], for communicating with iwd - two or more machines with a WiFi adapter having ibss support, called @@ -53,8 +53,8 @@ with anyone currently at risk of death in overcrowded prisons. ## Installing -This program is available in the AUR for Arch users. Building -manually for other distributions may not always work. +This program is available in the AUR for Arch users. Users of other +distributions will have to build manually. ### Arch Linux @@ -65,21 +65,17 @@ development version) from the AUR with your favourite helper: yay -S naxalnet ``` -Optionally, [setup systemd-resolved][arch-resolved] for DNS if any -of the nodes have internet access. [Start naxalnet][startnx] when -you need it. +Optionally, [setup systemd-resolved][arch-resolved] for DNS. [Start +naxalnet][startnx] when you need it. -### Ubuntu +### Debian or Ubuntu -naxalnet is not packaged for Ubuntu, so you will have to build -and install it manually. -Currently, only the **unreleased 21.10** comes with the -required version of systemd. Therefore, naxalnet **won't work on Ubuntu -21.04 or older**. +naxalnet is not packaged for Debian or Ubuntu, so you will have to build +and install it manually. Currently, only Debian experimental and Ubuntu +21.10 comes with the required version of systemd. Therefore, naxalnet +requires **Debian experimental** or **Ubuntu 21.10 or greater** to work. - - -Install the requirements from the Ubuntu repositories: +Install the requirements from the repositories: ```sh # batctl is optional @@ -106,7 +102,24 @@ Now head over to the [next section][install-manual] to install naxalnet. ### Manually -Install the [requirements][requirements]. +Verify that the [requirements][] are of required versions. + +```sh +# Should be greater than or equal to 2021.0 +batctl -v + +# 248 or greater +systemctl --version + +# Atleast 4.4 +uname -r + +# >= 3.6 +python3 --version + +# Check for IBSS (ad-hoc) support in your WiFi firmware or driver +iw phy | grep -iq ibss && echo "IBSS is supported" || echo "IBSS not supported" +``` Clone the naxalnet repo and cd into it. @@ -135,7 +148,8 @@ To upgrade, clean the build files, update the repo and reinstall: make clean git pull make -sudo make uninstall install +sudo make uninstall +sudo make install ``` This will keep the configuration files.