libperry/pybatmesh
1
0
Fork 0
mirror of https://git.disroot.org/pranav/pybatmesh.git synced 2024-11-10 07:21:59 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

commented out some parts in README

Browse Source 
added info about new branch
This commit is contained in:
Pranav Jerry 2021-05-21 20:18:49 +05:30
parent e1fe05b280
commit a2129e40e5
1 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -8,11 +8,13 @@ you can only communicate with other peers running the same software.
The name naxal comes from Naxalbari, a village in Darjeeling,
West Bengal.
A rewrite in python is in progress in the branch python-rewrite.
<!-- UNCOMMENT WHEN NECESSARY
**Disclaimer**:
In case you are either 1) a complete idiot; or 2) a member of parliament in
India; or 3) both, please be aware that this project is not affiliated with
In case you are either 1) a complete idiot; or 2) a member of parliament;
or 3) both, please be aware that this project is not affiliated with
any groups designated as terrorist groups in India.
Using the name Naxal does not imply any form of connection
@ -37,12 +39,12 @@ and others which can work without internet access.
## Requirements
* systemd v248 or more (for batman support)
* Linux kernel with batman-adv module (if `modinfo batman-adv` shows no error
- 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
- iwd (for starting ad-hoc network)
- wifi adapter with ad-hoc support
- two or more computers with wifi adapter
## Installing
@ -53,6 +55,7 @@ Clone the repo and cd into it.
Run `sudo make install` to install naxalnet. This will install naxalnet in
`/usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}`.
<!-- commented out as you'll have to edit the systemd service for this to work
To install in /usr/local instead, use `sudo make install PREFIX=/usr/local`.
After installing, reload systemd so that you can enable `naxalnet@.service`
@ -68,7 +71,7 @@ Any network managers such as NetworkManager and wifi daemons like
wpa_supplicant should be disabled:
```
sudo systemctl disable --now NetworkManager wpa_supplicant
sudo systemctl disable --now NetworkManager
```
Enable the naxalnet service on the device `wlan0` (iwd replaces interface
@ -85,10 +88,12 @@ the files:
```
sudo rm -r /usr/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
```
<!--
Or if you installed naxalnet in /usr/local:
```
sudo rm -r /usr/local/{bin/naxalnet,share/naxalnet/,lib/systemd/system/naxalnet@.service}
```
-->
## TODO