X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=README;h=4be546c0303b233d15893e2846ee84d37783ee2a;hb=e4bea38d3c0bb10ee187a43ff71b54ab6770940a;hp=e69de29bb2d1d6434b8b29ae775ad8c2e48c5391;hpb=019e512dab8c8c3e4cd3ba68c742fa4d1893b6c0;p=autobuildrequires.git

diff --git a/README b/README
index e69de29..4be546c 100644
--- a/README
+++ b/README
@@ -0,0 +1,28 @@
+Auto-BuildRequires is a simple set of scripts for automatically
+suggesting BuildRequires lines for programs.
+
+Written by Richard W.M. Jones, rjones@redhat.com,
+http://et.redhat.com/~rjones/
+http://et.redhat.com/~rjones/auto-buildrequires/
+
+Usage:
+
+  auto-br-rpmbuild -ba foo.spec
+
+If your build command is more complex, try:
+
+  auto-br [command ...]
+
+
+Developers
+----------------------------------------------------------------------
+
+The basic "magic" is a C LD_PRELOAD module, auto-buildrequires-preload.c,
+which intercepts some system calls to determine which files the build
+is looking at.  Those get logged to a simple text file.
+
+The Perl analysis script, auto-br-analyze.pl.in, runs afterwards on
+the logfile, and uses rpm to find out which packages those files
+belong to.  Those are printed out as the list of BuildRequires.
+
+A shell script, auto-br.sh.in, holds the whole thing together.