diff --git a/Contributing/Developement setup.md b/Contributing/Developement setup.md deleted file mode 100644 index 84e291d..0000000 --- a/Contributing/Developement setup.md +++ /dev/null @@ -1,25 +0,0 @@ -This document describes how to setup your development environment to contribute to this program. - -## Using VSCode and Docker - -That should be easier and better than a local setup, although it might use more memory if you're not on Linux. - -The repository .devcontainer [readme document](https://github.com/qdm12/gluetun/tree/master/.devcontainer#development-container) explains its setup. - -## Local installation - -1. Install [Go](https://golang.org/dl/) -1. Install [Git](https://git-scm.com/downloads) -1. Download the dependencies - - ```sh - go mod download - ``` - -1. Install [golangci-lint](https://github.com/golangci/golangci-lint#install) -1. You might want to use an IDE such as VSCode with the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go) -1. You might want to install [Docker](https://www.docker.com/products/docker-desktop) to build and run the image. - -## Next steps - -Go to the [development commands document](Developement-commands) diff --git a/Contributing/Development commands.md b/Contributing/Development commands.md deleted file mode 100644 index 8839527..0000000 --- a/Contributing/Development commands.md +++ /dev/null @@ -1,12 +0,0 @@ -Once your [development setup](Development-setup) is complete, you have the following commands available. - -- Test the code: `go test ./...` -- Lint the code `golangci-lint run` -- Build the Docker image (tests and lint included): `docker build -t qmcgaw/gluetun .` -- Run the Docker container: `docker run -it --rm --cap-add=NET_ADMIN -e OPENVPN_USER=test -e OPENVPN_PASSWORD=test qmcgaw/gluetun` - -Other useful commands: - -- Update all servers information: `go run cmd/gluetun/main.go update -help` - -Now have a look at the [guidelines](Developement-guidelines) to know where to start coding. diff --git a/Contributing/Development guidelines.md b/Contributing/Development guidelines.md deleted file mode 100644 index 6514cef..0000000 --- a/Contributing/Development guidelines.md +++ /dev/null @@ -1,5 +0,0 @@ -The Go code is in the Go file [cmd/main.go](https://github.com/qdm12/gluetun/blob/master/cmd/main.go) and the [internal directory](https://github.com/qdm12/gluetun/tree/master/internal), you might want to start reading the main.go file. - -See the [Contributing document](https://github.com/qdm12/gluetun/blob/master/.github/CONTRIBUTING.md) for more information on how to contribute to this repository. - -As always, feel free to reach out to me if you have any question. diff --git a/Contributing/Development.md b/Contributing/Development.md new file mode 100644 index 0000000..070e93c --- /dev/null +++ b/Contributing/Development.md @@ -0,0 +1,47 @@ +## Setup + +This document describes how to setup your development environment to contribute to this program. + +### Using VSCode and Docker + +That should be easier and better than a local setup, although it might use more memory if you're not on Linux. + +The repository .devcontainer [readme document](https://github.com/qdm12/gluetun/tree/master/.devcontainer#development-container) explains its setup. + +### Local installation + +1. Install [Go](https://golang.org/dl/) +1. Install [Git](https://git-scm.com/downloads) +1. Download the dependencies + + ```sh + go mod download + ``` + +1. Install [golangci-lint](https://github.com/golangci/golangci-lint#install) +1. You might want to use an IDE such as VSCode with the [Go extension](https://marketplace.visualstudio.com/items?itemName=golang.go) +1. You might want to install [Docker](https://www.docker.com/products/docker-desktop) to build and run the image. + +## Commands + +Once your [development setup](Development-setup) is complete, you have the following commands available. + +- Test the code: `go test ./...` +- Lint the code `golangci-lint run` +- Build the Docker image (tests and lint included): `docker build -t qmcgaw/gluetun .` +- Run the Docker container: `docker run -it --rm --cap-add=NET_ADMIN -e OPENVPN_USER=test -e OPENVPN_PASSWORD=test qmcgaw/gluetun` + +Other useful commands: + +- Update all servers information: `go run cmd/gluetun/main.go update -help` + +Now have a look at the [guidelines](Developement-guidelines) to know where to start coding. + +## Guidelines + +The Go code is in the Go file [cmd/main.go](https://github.com/qdm12/gluetun/blob/master/cmd/main.go) and the [internal directory](https://github.com/qdm12/gluetun/tree/master/internal), you might want to start reading the main.go file. + +See the [Contributing document](https://github.com/qdm12/gluetun/blob/master/.github/CONTRIBUTING.md) for more information on how to contribute to this repository. + +As always, feel free to reach out to me if you have any question. + diff --git a/_Sidebar.md b/_Sidebar.md index e2595bf..f6443ad 100644 --- a/_Sidebar.md +++ b/_Sidebar.md @@ -20,7 +20,5 @@ - [Surfshark Servers](Surfshark-Servers) - [Updating Servers](Updating-Servers) - Contributing - - [Developement setup](Developement-setup) - - [Development commands](Development-commands) - - [Development guidelines](Development-guidelines) + - [Developement](Developement) - [More information](More-information)