Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve contribution documentation #35

Merged
merged 1 commit into from Oct 5, 2017
Merged

Improve contribution documentation #35

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 17 additions & 11 deletions CONTRIBUTING.md
View file
Open in desktop
@@ -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
Expand All @@ -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
------------
Expand Down Expand Up @@ -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
```