Accept -Wformat=2 because it implies -Wformat.

[blhc/blhc.git] / README

diff --git a/README b/README
index 08b6879401ddd67b2c8abf9261d220c7b1ee9e0b..7b575b5da8b8b2ede674a440c7bd922dca127947 100644 (file)
--- a/README
+++ b/README
@@ -19,6 +19,9 @@ to help maintainers detect missing hardening flags in their packages.
 At the moment it works only on Debian and derivatives but it should be easily
 extendable to other systems as well. Patches are welcome.
 
+Only gcc is detected as compiler at the moment. If other compilers support
+hardening flags as well, please report them.
+
 For more information about hardening flags have a look at [1].
 
 [1]: https://wiki.debian.org/Hardening
@@ -30,6 +33,10 @@ DEPENDENCIES
 - Perl
   - Dpkg::Arch
   - Dpkg::Version
+  - Term::ANSIColor >= 2.01
+    Bundled with perl. A recent version is only necessary for build logs with
+    ANSI colors which is rare, blhc works fine without if the build log
+    doesn't use colors. Not required for buildd mode.
 
 
 USAGE
@@ -37,6 +44,12 @@ USAGE
 
     blhc path/to/log/file
 
+blhc can be run directly from the source tree (`bin/blhc`) or copied anywhere
+on the system. It doesn't have to be explicitly installed. To read the man
+page use `perldoc bin/blhc`.
+
+If there's no output, no flags are missing and the build log is fine.
+
 For more examples see the man page.