libperry/pybatmesh
1
0
Fork 0
mirror of https://git.disroot.org/pranav/pybatmesh.git synced 2024-12-25 17:49:45 +05:30
Code Issues Actions Packages Projects Releases Wiki Activity

updated README, added pyproject.toml

Browse Source
This commit is contained in:
Pranav Jerry 2021-09-08 11:57:10 +05:30
parent ca1e721c9e
commit c638de4c9c
No known key found for this signature in database
GPG Key ID: F1DCDC4FED0A0C5B
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -45,12 +45,12 @@ with anyone currently at risk of death in overcrowded prisons.
- [iwd][] for controlling the WiFi adapter - [iwd][] for controlling the WiFi adapter
- python3 - python3
- python3-setuptools, for building and installing naxalnet - python3-setuptools, for building and installing naxalnet
- python3-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 ad-hoc support, called - two or more machines with a WiFi adapter having ibss support, called
nodes or peers nodes or peers
- batctl (optional, for debugging) - batctl (optional, for debugging)
- python3-pip (optional, for `make uninstall` to work) - python3-pip (for installing dasbus on Debian-based distributions)
## Installing ## Installing
@ -122,9 +122,10 @@ Or, if you have an [IPFS client][ipfs] running, try this instead:
git clone http://k51qzi5uqu5dlye74be0n9iihwk6sm54vexo7bf7pdr4w811y6mmrcp25djozv.ipns.localhost:8080/naxalnet.git git clone http://k51qzi5uqu5dlye74be0n9iihwk6sm54vexo7bf7pdr4w811y6mmrcp25djozv.ipns.localhost:8080/naxalnet.git
``` ```
Now, install naxalnet: Now, build and install naxalnet:
```sh ```sh
make
sudo make install sudo make install
``` ```
@ -135,6 +136,17 @@ service files:
sudo systemctl daemon-reload sudo systemctl daemon-reload
``` ```
To upgrade, clean the build files, update the repo and reinstall:
```sh
make clean
git pull
make
sudo make uninstall install
```
This will keep the configuration files.
## How to use ## How to use
You need more than one machine running naxalnet for the connection to work. You need more than one machine running naxalnet for the connection to work.
@ -222,7 +234,7 @@ naxalnet --help
## How it works ## How it works
There are three modes commonly supported by WiFi adapters - `ap` (WiFi There are three modes commonly supported by WiFi adapters - `ap` (WiFi
hotspot), `station` (for joining WiFi networks) and `ad-hoc` (for hotspot), `station` (for joining WiFi networks) and `ad-hoc` (or ibss, for
decentralised networks). There are other modes supported by some WiFi decentralised networks). There are other modes supported by some WiFi
adapters too, like `p2p` (WiFi direct), but this program doesn't use them. adapters too, like `p2p` (WiFi direct), but this program doesn't use them.
@ -321,3 +333,4 @@ See [LICENSE](LICENSE) for the complete version of the license.
[enablenx]: #running-at-boot [enablenx]: #running-at-boot
[requirements]: #requirements [requirements]: #requirements
[install-manual]: #manually [install-manual]: #manually
[python-systemd]: https://github.com/systemd/python-systemd

3
pyproject.toml Normal file
View File

@ -0,0 +1,3 @@
[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"