Adds instructions on installing required dependencies

Following these instructions allowed me to successfully run the tests
This commit is contained in:
christiaan
2016-08-29 20:41:40 +02:00
parent 18b5dcf10d
commit a6c8e00410

View File

@@ -4,6 +4,17 @@ Thanks for taking a look at go-i2p! Please reach out if you have any questions
## Getting Starting
Install required dependencies
This example assumes Ubuntu 16.04
```sh
sudo apt-get install pkg-config libsodium-dev
go get github.com/hkparker/go-i2p
go get github.com/sirupsen/logrus
go get github.com/stretchr/testify/assert
```
Fork go-i2p and clone it into your workspace. Make sure you can execute `go test ./...` in the project's root directory. At that point you should have everything you need to start making changes and opening pull requests. If you aren't sure what to work on, take a look at some good [getting started issues](https://github.com/hkparker/go-i2p/issues?q=is%3Aopen+is%3Aissue+label%3A%22start+here%22).
## I2P Specifications