diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e6996e4cb..89a95950c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,6 @@ # Contributing guide -Running ------------- -``` bash -bin/server_build -bin/server_run - -bin/client_build -bin/client_run -``` - - Development environment ------------ * **Step 1.** Get Golang @@ -30,6 +19,20 @@ glide install go build github.com/mysterium/node ``` +Running +------------ +``` bash +# Start communication gateway +docker-compose up gateway + +# Start node +bin/server_build +bin/server_run --node 123456 + +# Client connects to node +bin/client_build +bin/client_run --node 123456 +``` Dependency management ------------ @@ -59,14 +62,17 @@ See http://fpm.readthedocs.io/en/latest/installing.html ```bash brew install gnu-tar gem install --no-ri --no-rdoc fpm +``` * **Step 2.** Get Debber tool See https://github.com/debber/debber-v0.3 ```bash go get github.com/debber/debber-v0.3/cmd/... +``` * **Step 3.** Build .deb package ```bash bin/server_package_debian 0.0.6 amd64 bin/client_package_debian 0.0.6 amd64 +```