From c638de4c9c0ef7f7f05caa429d48ef11034a66b8 Mon Sep 17 00:00:00 2001 From: Pranav Jerry Date: Wed, 8 Sep 2021 11:57:10 +0530 Subject: [PATCH] updated README, added pyproject.toml --- README.md | 23 ++++++++++++++++++----- pyproject.toml | 3 +++ 2 files changed, 21 insertions(+), 5 deletions(-) create mode 100644 pyproject.toml diff --git a/README.md b/README.md index 2b2a3fd..26201d5 100644 --- a/README.md +++ b/README.md @@ -45,12 +45,12 @@ with anyone currently at risk of death in overcrowded prisons. - [iwd][] for controlling the WiFi adapter - python3 - 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 -- 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 - batctl (optional, for debugging) -- python3-pip (optional, for `make uninstall` to work) +- python3-pip (for installing dasbus on Debian-based distributions) ## 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 ``` -Now, install naxalnet: +Now, build and install naxalnet: ```sh +make sudo make install ``` @@ -135,6 +136,17 @@ service files: 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 You need more than one machine running naxalnet for the connection to work. @@ -222,7 +234,7 @@ naxalnet --help ## How it works 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 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 [requirements]: #requirements [install-manual]: #manually +[python-systemd]: https://github.com/systemd/python-systemd diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..9787c3b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta"