Add basic readme
This commit is contained in:
parent
138b394cf0
commit
6586166282
21
Readme.md
Normal file
21
Readme.md
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
# gooni
|
||||||
|
|
||||||
|
An attempt at writing OONI Probe in golang.
|
||||||
|
|
||||||
|
This is heavy work in progress.
|
||||||
|
|
||||||
|
## Development setup
|
||||||
|
|
||||||
|
This project uses `dep` with the `vendor/` dir in `.gitignore`.
|
||||||
|
|
||||||
|
Once you have `dep` installed, run:
|
||||||
|
|
||||||
|
```
|
||||||
|
dep ensure
|
||||||
|
```
|
||||||
|
|
||||||
|
You should then be able to build a ooni binary by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
make build
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user