mirror of
https://git.disroot.org/pranav/pybatmesh.git
synced 2025-01-09 08:23:58 +05:30
made README better
Added info on how to check requirements
This commit is contained in:
parent
61a96ea3b3
commit
6acd7084f2
54
README.md
54
README.md
@ -39,11 +39,11 @@ with anyone currently at risk of death in overcrowded prisons.
|
|||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- [systemd-networkd v248 or more][batman-systemd]
|
- [systemd-networkd v248 or greater][batman-systemd]
|
||||||
- Linux kernel with batman-adv module
|
- Linux kernel with [batman-adv v2021.0][batman-systemd] or greater
|
||||||
- [iwd][] for controlling the WiFi adapter
|
- [iwd][] for controlling the WiFi adapter
|
||||||
- python3
|
- python (atleast 3.6)
|
||||||
- python3-setuptools, for building and installing naxalnet
|
- python setuptools, for building and installing naxalnet
|
||||||
- [python-systemd][], for logging to systemd journal
|
- [python-systemd][], for logging to systemd journal
|
||||||
- [dasbus][], for communicating with iwd
|
- [dasbus][], for communicating with iwd
|
||||||
- two or more machines with a WiFi adapter having ibss support, called
|
- 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
|
## Installing
|
||||||
|
|
||||||
This program is available in the AUR for Arch users. Building
|
This program is available in the AUR for Arch users. Users of other
|
||||||
manually for other distributions may not always work.
|
distributions will have to build manually.
|
||||||
|
|
||||||
### Arch Linux
|
### Arch Linux
|
||||||
|
|
||||||
@ -65,21 +65,17 @@ development version) from the AUR with your favourite helper:
|
|||||||
yay -S naxalnet
|
yay -S naxalnet
|
||||||
```
|
```
|
||||||
|
|
||||||
Optionally, [setup systemd-resolved][arch-resolved] for DNS if any
|
Optionally, [setup systemd-resolved][arch-resolved] for DNS. [Start
|
||||||
of the nodes have internet access. [Start naxalnet][startnx] when
|
naxalnet][startnx] when you need it.
|
||||||
you need it.
|
|
||||||
|
|
||||||
### Ubuntu
|
### Debian or Ubuntu
|
||||||
|
|
||||||
naxalnet is not packaged for Ubuntu, so you will have to build
|
naxalnet is not packaged for Debian or Ubuntu, so you will have to build
|
||||||
and install it manually.
|
and install it manually. Currently, only Debian experimental and Ubuntu
|
||||||
Currently, only the **unreleased 21.10** comes with the
|
21.10 comes with the required version of systemd. Therefore, naxalnet
|
||||||
required version of systemd. Therefore, naxalnet **won't work on Ubuntu
|
requires **Debian experimental** or **Ubuntu 21.10 or greater** to work.
|
||||||
21.04 or older**.
|
|
||||||
|
|
||||||
<!-- TODO: remove this message if systemd 248 arrives in 21.04 -->
|
Install the requirements from the repositories:
|
||||||
|
|
||||||
Install the requirements from the Ubuntu repositories:
|
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# batctl is optional
|
# batctl is optional
|
||||||
@ -106,7 +102,24 @@ Now head over to the [next section][install-manual] to install naxalnet.
|
|||||||
|
|
||||||
### Manually
|
### 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.
|
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
|
make clean
|
||||||
git pull
|
git pull
|
||||||
make
|
make
|
||||||
sudo make uninstall install
|
sudo make uninstall
|
||||||
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
This will keep the configuration files.
|
This will keep the configuration files.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user