[Reproducible-commits] [reprotest] 01/02: Improve README.md

[Ceridwen]

This is an automated email from the git hooks/post-receive script.

ceridwen-guest pushed a commit to annotated tag 0.1
in repository reprotest.

commit 702ec06efb53a3a195e0b22d001b974b594cc7ae
Author: Ceridwen <ceridwenv at gmail.com>
Date:   Tue Jun 14 12:00:01 2016 -0400

    Improve README.md
---
 README.md | 44 +++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 43 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 69f429b..fee71f9 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,43 @@
-Invoke with 'reprotest.'
+reprotest's CLI takes two mandatory arguments, the build command to
+run and the build artifact file to test after running the build.  If
+the build command or build artifact have spaces, they have to be
+passed as strings, e.g. `"debuild -b -uc -us"`.  For optional
+arguments, it has `--variations`, which accepts a list of possible
+build variations to test, one or more of 'captures_environment',
+'domain_host', 'filesystem', 'home', 'kernel', 'locales', 'path',
+'shell', 'time', 'timezone', 'umask', and 'user_group' (see
+[variations](https://tests.reproducible-builds.org/index_variations.html)
+for more information); `--dont_vary`, which makes reprotest *not* test
+any variations in the given list (the default is to run all
+variations); `--source_root`, which accepts a directory to run the
+build command in and defaults to the current working directory; and
+--verbose, which will eventually enable more detailed logging.  To get
+help for the CLI, run `reprotest -h` or `reprotest --help`.
+
+The config file has one section, basics, and the same options as the
+CLI, except there's no dont_vary option, and there are `build_command`
+and `artifact` options.  If `build_command` and/or `artifact` are set
+in the config file, reprotest can be run without passing those as
+command-line arguments.  Command-line arguments always override config
+file options.  Reprotest currently searches the working directory for
+the config file, but it will also eventually search the user's home
+directory.  A sample config file is below.
+
+    [basics]
+    build_command = setup.py sdist
+    artifact = dist/reprotest-0.1.tar.gz
+    source_root = reprotest/
+    variations =
+      captures_environment
+      domain_host
+      filesystem
+      home
+      host
+      kernel
+      locales
+      path
+      shell
+      time
+      timezone
+      umask
+      user_group

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/reproducible/reprotest.git