From 1ab8729390ccee5282c2a403f26759c94dabc3ff Mon Sep 17 00:00:00 2001 From: Mark Puha Date: Sun, 3 Sep 2023 13:31:21 +0200 Subject: [PATCH] Update README.md Signed-off-by: Mark Puha Signed-off-by: Mark Puha --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cbd8f25..620851c 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,6 @@ This is an implementation of WireGuard in Go. ## Usage -### Config gen -The configs are generate from a yml file. If you want to change the config run `make cfg_gen config_name` where `config_name` is the name of the yaml file you'd like to generate from. The script will search in the `cfg/settings/` folder - -### Example: -`make cfg_gen default` will generate a config from `cfg/settings/default.yml` the file will be called `cfg/cfg_values.go` - -Every time you make changes to the yml you need to rerun this. - Most Linux kernel WireGuard users are used to adding an interface with `ip link add wg0 type wireguard`. With wireguard-go, instead simply run: ``` @@ -59,6 +51,18 @@ This requires an installation of the latest version of [Go](https://go.dev/). ``` $ git clone https://git.zx2c4.com/wireguard-go $ cd wireguard-go +``` + +### Config gen +The configs are generate from a yml file. If you want to change the config run `make cfg_gen config_name` where `config_name` is the name of the yaml file you'd like to generate from. The script will search in the `cfg/settings/` folder + +### Example: +`make cfg_gen default` will generate a config from `cfg/settings/default.yml` the file will be called `cfg/cfg_values.go` + +Every time you make changes to the yml you need to rerun. + +After the generation is done you can build with: +``` $ make ```