From bf19fc1064d06655dcd63e3debee10c0936d1b18 Mon Sep 17 00:00:00 2001 From: Patrick Marchand Date: Mon, 24 Dec 2018 11:30:00 -0500 Subject: [PATCH] Added a small description to the README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a17f01e..1433c16 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ +# Evocheck -# How to build the package for a new release +This program scans the machine it is run on and verifies if it +adheres to the Evolix standard, non-compliance warnings are outputted +on standard out. + +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 On the master branch, add the last stable version with a release tag. ```