Skip to content

Commit 8a1ddfc

Browse files
committed
Add development documentation
1 parent 5e4d193 commit 8a1ddfc

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,33 @@ This will generate a `staticAssets.json` file in this directory like this:
6565
*Note* - The default bucket is used by multiple teams, so if you use that you
6666
must specify a directory to use for your project as not to create unnecessary
6767
collisions.
68+
69+
### Development
70+
71+
To work on this project you'll need [Golang](https://golang.org/dl/) and
72+
the [Glide package manager](https://glide.sh/) installed. You should have
73+
your `GOPATH` environment variable set and this repo should be cloned within
74+
your `$GOPATH/src/github.com/bufferapp` directory.
75+
76+
To install the dependencies, run:
77+
78+
```
79+
glide install
80+
```
81+
82+
To test the script run:
83+
84+
```
85+
go run main.go <your cli arguments here>
86+
```
87+
88+
When distributing a new release version, run this script to generate the
89+
binaries for Linux and Mac:
90+
91+
```
92+
./build.sh
93+
```
94+
95+
### License
96+
97+
MIT

0 commit comments

Comments
 (0)