diff --git a/CHANGELOG.md b/CHANGELOG.md index 881fec9..74bbfa4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,15 +5,15 @@ ### Added - Support for arguments -- Configuration file support -- New versioning scheme that conforms to PEP 440 +- Configuration file support with fallback values - Made messages more readable - Improved documentation in docstrings ### Changed -- Changed default name of mesh network. This will make naxalnet - incompatible with previous versions. +- Changed default name of mesh network. **This will make naxalnet + incompatible with previous versions.** +- New versioning scheme that conforms to PEP 440 ## [v0.2.0][] - 2021-07-26 @@ -27,7 +27,9 @@ ## [v0.1.0][] - 2021-06-19 -Initial version +Initial version. At first, this was a shell script. Than it was converted +into a single python file that did just what the shell script used to do. +The shell script was not given a version. [unreleased]: https://git.disroot.org/pranav/naxalnet/compare/v0.2.0...HEAD [v0.2.0]: https://git.disroot.org/pranav/naxalnet/compare/v0.1.0...v0.2.0 diff --git a/HACKING.md b/HACKING.md index bf8780c..beb9b89 100644 --- a/HACKING.md +++ b/HACKING.md @@ -10,17 +10,21 @@ relevant label. ## Improving documentation -See section below +The README and HACKING.md needs to be more beginner friendly. +See section below. ## Contribute code To push to this repo, you need your username to be in the -contributors list. See issue #8. Before each commit, update -the CHANGELOG and `__version__` in `naxalnet/__init__.py` +contributors list. Add your username to issue #8 to add you +as a contributor. Before each commit, update the CHANGELOG.md +and `__version__` in `naxalnet/__init__.py` ## Packaging -naxalnet needs distro packages in Debian, Fedora, openSUSE, +Currently this program is only packaged for Arch Linux. +naxalnet needs packages in GNU+Linux+systemd +distributions such as Debian, Fedora, openSUSE, and nixos. If you know/like to package it in your distro, post to issue #6. diff --git a/MANIFEST.in b/MANIFEST.in index 1041071..6fd0ca8 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,5 @@ include LICENSE include README.md include naxalnet.service +include naxalnet.conf include systemd-networkd/* diff --git a/Makefile b/Makefile index b79d58b..252c231 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ # This makefile uses setup.py under the hood. -# In ubuntu, python and pip are symlinks to python2 and pip2. -# So we have to specify python as python3 by default. +# In ubuntu, python and pip are symlinks to python2 and pip2, not +# python3. So we have to specify python as python3 by default. PYTHON := python3 PIP := pip3 DESTDIR:= / diff --git a/README.md b/README.md index ebb1268..b91555d 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,19 @@ West Bengal. WARNING: This program uses an **unencrypted** network. This means -you do not get any more privacy or security than with an open wifi +you do not get any more privacy or security than with an open WiFi network.