README

   1 README for archives2git
   2 =======================
   3
   4 `archives2git` is intended to recreate a poor-man's history from the (release)
   5 archives of a project.  It is an sh script that commits the given file archives
   6 to a Git repository as a series of commits; by default the commit (sub-)trees
   7 will replicate the contents of their corresponding archive.
   8
   9 Resources
  10 ---------
  11
  12 For the documentation see the manual of linkpage:archives2git[1] (or the help
  13 message output), then look inside the configuration file example
  14 link:archives2gitrc[.archives2gitrc] and finally inside the
  15 link:archives2git[script].
  16
  17 Basic usage:
  18
  19         $ cd git-repo # may be a subdir of the toplevel of a repo
  20         $ GIT_AUTHOR_NAME="Firstname Lastname" GIT_AUTHOR_EMAIL=user@host \
  21           archives2git --tag ../oldproject-?.??.tar.gz
  22
  23 Limitions & Bugs
  24 ----------------
  25
  26 * Trailing newlines in file names are not supported.
  27
  28 Dependencies
  29 ------------
  30
  31 * POSIX `sh`
  32 * `mktemp`
  33 * `aunpack` from link:http://www.nongnu.org/atool/[atool]
  34 * `git`