Add testing and licence documentation to README.md

This commit is contained in:
Victor LABORIE 2019-01-14 18:04:28 +01:00
parent e6e0b8c216
commit 0f95043daf

View file

@ -9,7 +9,7 @@ It is currently adapted for Debian and OpenBSD systems.
Configure by modifying evocheck.cf and use the VagrantFile to test
it.
# How to build the package for a new Debian release
## How to build the package for a new Debian release
On the master branch, add the last stable version with a release tag.
```
@ -32,3 +32,39 @@ If the build is OK, you can now build the final package.
dch -D stretch -r
gbp buildpackage --git-debian-branch=debian --git-upstream-tree=master --git-export-dir=/tmp/build-area --git-tag --git-sign --git-keyid=<KEY>
```
## Testing
Evocheck can be tested with Vagrant, if you don't have installed it yet :
~~~
apt install vagrant vagrant-libvirt
~~~
You can now start your Vagrant machine and connect to it :
~~~
vagrant up
vagrant ssh
sudo -i
~~~
Evocheck can be run with :
~~~
/usr/share/scripts/evocheck.sh
~~~
### Deployment
Launch **vagrant rsync-auto** in a terminal to automatically synchronise
your local code with the Vagrant VM :
~~~
vagrant rsync-auto
~~~
## License
This is an [Evolix](https://evolix.com) project and is licensed
under the GPLv3, see the [LICENSE](LICENSE) file for details.