holm/wg-meshconf
1
0
Fork 0
forked from extern/wg-meshconf
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added installation guide

Browse Source
This commit is contained in:
K4YT3X 2020-11-15 22:33:33 -05:00
parent f4cbfd503f
commit 3af2b93560
1 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -19,7 +19,33 @@ wg-meshconf is a tool that will help you to generate peer configuration files fo
It is highly recommended to install `prettytable` so you can get beautiful tabular display of peer information. If you choose not to install `prettytable`, only plaintext output will be available.
Python packages can be installed via `pip3 install --user -Ur requirements.txt`.
## Installation
You can clone this repository using `git`.
```shell
git clone https://github.com/k4yt3x/wg-meshconf.git
```
Alternatively, you can download the [master branch's ZIP file](https://github.com/k4yt3x/wg-meshconf/archive/master.zip) and decompress it. You may use any program to download and decompress the ZIP file. The example below uses `wget` and `unzip` to do the job on Linux.
```shell
# download the master branch's ZIP file
wget https://github.com/k4yt3x/wg-meshconf/archive/master.zip
# decompress the ZIP file
unzip wg-meshconf-master.zip
```
Then, you will need to install Python's dependencies.
```shell
# if you cloned this repository
pip3 install --user -Ur wg-meshconf/src/requirements.txt
# if you downloaded and decompressed the zip file
pip3 install --user -Ur wg-meshconf-master/src/requirements.txt
```
## Learn by an Example