Add README file.
authorStefan Schantl <stefan.schantl@ipfire.org>
Mon, 27 Jun 2016 10:19:16 +0000 (12:19 +0200)
committerStefan Schantl <stefan.schantl@ipfire.org>
Mon, 27 Jun 2016 10:19:16 +0000 (12:19 +0200)
This file provides basic informations about guardian,
it's dependencies and how to build and install it.

Signed-off-by: Stefan Schantl <stefan.schantl@ipfire.org>
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..ab8cbc5
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+guardian
+
+A perl written Intrusion Prevention System.
+
+WEB HOME:
+       http://git.ipfire.org/?p=people/stevee/guardian.git;a=summary
+
+BUGTRACKER:
+       Please report any found bugs to the IPFire development mailing list
+       <development@lists.ipfire.org> until a bugtracker will be available.
+
+LICENSE:
+       The authors licensed their work as free software under the terms of
+       the
+
+               GNU GENERAL PUBLIC LICENSE v3.0+
+
+       Any content besides source code (images, etc.) is licensed under the
+       terms of the
+
+               Creative Commons Attribution ShareAlike 3.0 Unported
+
+       license.
+
+INSTALLATION:
+       REQUIREMENTS:
+               guardian is written in pure Perl and requires the following third-party
+               modules to work:
+                       * Linux-Inotify2 (http://search.cpan.org/~mlehmann/Linux-Inotify2-1.22/)
+                       * Net-IP (http://search.cpan.org/~manu/Net-IP-1.26/)
+               The minimum version of Perl that has been tested is Perl 5.12.
+
+               Building the program requires:
+                       * GNU make
+                       * sed
+
+       INSTRUCTIONS:
+               To build and install run:
+                       make
+                       make install