Update readme, contributing guide

This commit is contained in:
Matej Kramny 2016-04-29 15:58:17 +02:00
parent 4787df9ee5
commit 1d5d311315
2 changed files with 58 additions and 17 deletions

23
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,23 @@
# Pull Requests
When creating a pull-request you should:
- __Open an issue first:__ Confirm that the change or feature will be accepted
- __gofmt and vet the code:__ Use `gofmt`, `golint`, `govet` and `goimports` to clean up your code.
- __Update api documentation:__ If your pull-request adding/modifying an API request, make sure you update the swagger documentation (`swagger.yml`)
# Installing dependencies
```
go get -u ./...
go get -u github.com/jteeuwen/go-bindata/...
go get github.com/mitchellh/gox
npm install -g nodemon less jade
```
# Running in development
```
# edit config.json file
./make.sh watch
```

View File

@ -2,24 +2,42 @@
[![Circle CI](https://circleci.com/gh/ansible-semaphore/semaphore.svg?style=svg&circle-token=3702872acf2bec629017fa7dd99fdbea56aef7df)](https://circleci.com/gh/ansible-semaphore/semaphore)
Beware WIP
Tests in progress.
## Requirements
## [Install Instructions](https://github.com/ansible-semaphore/semaphore/wiki/Installation)
## [Milestones](https://github.com/ansible-semaphore/semaphore/milestones)
## [Releases](https://github.com/ansible-semaphore/semaphore/releases)
- GIT installed and in $PATH
- Ansible installed and in $PATH
- Redis & MySQL/MariaDB
## Articles
## Getting started
- http://code-complete.com/code/?p=40
```
$ ./semaphore -printConfig > config.json
$ vim config.json
$ ./semaphore -migrate -config `path`/config.json
... migrations exec'd ...
$ ./semaphore -hash myPassword
... hash printed ...
$ add user with mysql
$ ./semaphore -config `path`/config.json
... listening on a port
```
## Contributing
PR's & UX reviews are welcome!
Please follow the [contribution](https://github.com/ansible-semaphore/semaphore/blob/master/CONTRIBUTING.md) guide. Any questions, please open an issue.
## License
MIT License
Copyright (c) 2016 Castaway Consulting LLC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.