forked from sloum/bombadillo
Added developer documentation, testing to Makefile
This commit is contained in:
parent
34e9e109e2
commit
45eabef945
4
Makefile
4
Makefile
|
@ -6,6 +6,7 @@ BINDIR := ${EXEC_PREFIX}/bin
|
||||||
DATAROOTDIR := ${PREFIX}/share
|
DATAROOTDIR := ${PREFIX}/share
|
||||||
MANDIR := ${DATAROOTDIR}/man
|
MANDIR := ${DATAROOTDIR}/man
|
||||||
MAN1DIR := ${MANDIR}/man1
|
MAN1DIR := ${MANDIR}/man1
|
||||||
|
test : GOCMD := go1.11.13
|
||||||
|
|
||||||
# Use a dateformat rather than -I flag since OSX
|
# Use a dateformat rather than -I flag since OSX
|
||||||
# does not support -I. It also doesn't support
|
# does not support -I. It also doesn't support
|
||||||
|
@ -47,3 +48,6 @@ clean:
|
||||||
uninstall: clean
|
uninstall: clean
|
||||||
rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz
|
rm -f ${DESTDIR}${MAN1DIR}/bombadillo.1.gz
|
||||||
rm -f ${DESTDIR}${BINDIR}/${BINARY}
|
rm -f ${DESTDIR}${BINDIR}/${BINARY}
|
||||||
|
|
||||||
|
.PHONY: test
|
||||||
|
test: clean build
|
||||||
|
|
|
@ -125,6 +125,14 @@ We aim for simplicity and quality, and do our best to make Bombadillo useful to
|
||||||
|
|
||||||
The maintainers use the [tildegit](https://tildegit.org) issues system to discuss new features, track bugs, and communicate with users regarding issues and suggestions. Pull requests should typically have an associated issue, and should target the `develop` branch.
|
The maintainers use the [tildegit](https://tildegit.org) issues system to discuss new features, track bugs, and communicate with users regarding issues and suggestions. Pull requests should typically have an associated issue, and should target the `develop` branch.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
Following the standard install instructions should lead you to have nearly everything you need to commence development. The only additions to this are:
|
||||||
|
|
||||||
|
- To be able to submit pull requests, you will need to fork this repository first.
|
||||||
|
- Bombadillo is tested against Go 1.11. This version can be installed as per the [Go install documentation](https://golang.org/doc/install#extra_versions). Tests for this version are run using 'make test'.
|
||||||
|
- Linting is performed by `gofmt` and [golangci-lint](https://github.com/golangci/golangci-lint)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the GNU GPL version 3. See the [LICENSE](LICENSE) file for details.
|
This project is licensed under the GNU GPL version 3. See the [LICENSE](LICENSE) file for details.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user