README

   1 README for gitchangelog.sh
   2 ==========================
   3
   4 `gitchangelog.sh` is a tiny, portable and fast sh script to reformat a Git log
   5 into a changelog close to a standard
   6 link:https://sourceware.org/glibc/wiki/Contribution%20checklist#Properly_Formatted_GNU_ChangeLog[GNU
   7 ChangeLog].  It is intended to generate a changelog for inclusion in a release.
   8
   9 Each commit message is made into a changelog entry and each paragraph is made
  10 into a star item of the changelog.  The message title is kept on a separate
  11 line.  There are options to keep only the title (as a single star item), to
  12 keep the whole body as is and to annotate the changelog with the repository
  13 tags or with merge markers.
  14
  15 Resources
  16 ---------
  17
  18 * Manual page: linkpage:gitchangelog.sh[1]
  19 * Changes: link:NEWS.html[+NEWS+]
  20 * Homepage: https://gitorious.org/graud-utils/gitchangelog-sh
  21
  22 Dependencies
  23 ------------
  24
  25 * POSIX `sh` (dash, bash, pdksh, mksh, ash and posh are supported)
  26 * POSIX `sed` (GNU, BSD and Heirloom sed are supported)
  27 * link:http://git-scm.com[Git] to generate a log
  28 * link:https://gitorious.org/graud-utils/helpmessage[HelpMessage] and
  29   link:http://perldoc.perl.org/pod2man.html[`pod2man`] to build the man page
  30
  31 Credits & License
  32 -----------------
  33
  34 gitchangelog.sh was written by G.raud Meyer.
  35
  36 This program is free software; you can redistribute it and/or modify it under
  37 the terms of the GNU General Public License version 2 as published by the Free
  38 Software Foundation.  The full text of the license can be found in the root
  39 directory of the project sources, in the file link:COPYING[+COPYING+].
  40 Otherwise see <http://www.gnu.org/licenses/>.