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 The file link:NEWS.html[+NEWS+] describes the important user visible changes.
  24 The project is available online at
  25 link:http://repo.or.cz/archives2git.git[repo.or.cz].
  26
  27 Limitions & Bugs
  28 ----------------
  29
  30 * Trailing newlines in file names are not supported.
  31
  32 Dependencies
  33 ------------
  34
  35 * POSIX `sh`
  36 * `sed` with Extended Regular Expressions (option -r) (GNU and BSD
  37   implementations are compatible)
  38 * `mktemp` (GNU and BSD implementations are supported)
  39 * `aunpack` from link:http://www.nongnu.org/atool/[atool] or from
  40   link:http://repo.or.cz/atool/gnatool.git[gnatool] is the default extraction
  41   command used
  42 * link:http://git-scm.com[Git]
  43 * link:http://repo.or.cz/shelmfish.git[SHelMFiSH/HelpMessage] and
  44   link:http://perldoc.perl.org/pod2man.html[`pod2man`] are required to build
  45   the manpage
  46 * link:http://joeyh.name/code/pristine-tar/[pristine-tar] can be used to embed
  47   the archives in the repository.
  48
  49 Credits & License
  50 -----------------
  51
  52 archives2git was written by G.raud Meyer.
  53
  54 This program is free software; you can redistribute it and/or modify it under
  55 the terms of the GNU General Public License version 2 as published by the Free
  56 Software Foundation.  The full text of the license can be found in the root
  57 directory of the project sources, in the file link:COPYING[+COPYING+].  Otherwise see
  58 <http://www.gnu.org/licenses/>.