doc: Update README.

author: Simon Josefsson <simon@josefsson.org> 2024-10-09 14:32:14 +0200
committer: Simon Josefsson <simon@josefsson.org> 2024-10-09 14:41:10 +0200
commit: 1599415916e95172d4935030c68ec59d744cbf49 (patch)
tree: 6bf32f4193ddabf0361ee6fade5f8ed63db2ef18
parent: 009e602f240b40ac4bf6b94a65e92c0efe86a700 (diff)
download: git2cl-1599415916e95172d4935030c68ec59d744cbf49.zip
git2cl-1599415916e95172d4935030c68ec59d744cbf49.tar.gz
git2cl-1599415916e95172d4935030c68ec59d744cbf49.tar.bz2
3 files changed, 48 insertions, 437 deletions
diff --git a/README b/README
deleted file mode 100644
index 4084080..0000000
--- a/README
+++ /dev/null
@@ -1,45 +0,0 @@
-git2cl
-======
-
-This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
-format.
-
-The tool invokes 'git log' internally unless you pipe a log to it.
-Thus, typically you would use it as follows:
-
-...........................................................................
-jas@mocca:~/src/libtasn1$ git2cl > ChangeLog
-jas@mocca:~/src/libtasn1$
-...........................................................................
-
-If you don't want git2cl to invoke git log internally, you can use it
-as a pipe.  It needs a git log generated with --pretty --numstat and
---summary.  You can use it as follows:
-
-...........................................................................
-jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl > ChangeLog
-jas@mocca:~/src/libtasn1$
-...........................................................................
-
-The output format is specified by:
-
-link:http://www.gnu.org/prep/standards/html_node/Change-Logs.html[]
-
-My inspiration for writing this tool was the
-link:http://www.red-bean.com/cvs2cl/[cvs2cl] tool, which I have been
-using in several projects.  Replacing it was necessary to seriously
-consider switching from CVS to GIT for my projects.
-
-The canonical home page for git2cl is:
-link:http://josefsson.org/git2cl/[] and its repository can be found at
-link:http://repo.or.cz/w/git2cl.git[].
-
-Credits
--------
-
-Luis Mondesi contributed several improvements.
-
-Support
--------
-
-Try talking to mailto:simon@josefsson.org[Simon Josefsson].
diff --git a/README.html b/README.html
deleted file mode 100644
index f82da5d..0000000
--- a/README.html
+++ /dev/null
@@ -1,392 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.2.7" />
-<style type="text/css">
-/* Debug borders */
-p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
-/*
-  border: 1px solid red;
-*/
-}
-
-body {
-  margin: 1em 5% 1em 5%;
-}
-
-a {
-  color: blue;
-  text-decoration: underline;
-}
-a:visited {
-  color: fuchsia;
-}
-
-em {
-  font-style: italic;
-  color: navy;
-}
-
-strong {
-  font-weight: bold;
-  color: #083194;
-}
-
-tt {
-  color: navy;
-}
-
-h1, h2, h3, h4, h5, h6 {
-  color: #527bbd;
-  font-family: sans-serif;
-  margin-top: 1.2em;
-  margin-bottom: 0.5em;
-  line-height: 1.3;
-}
-
-h1, h2, h3 {
-  border-bottom: 2px solid silver;
-}
-h2 {
-  padding-top: 0.5em;
-}
-h3 {
-  float: left;
-}
-h3 + * {
-  clear: left;
-}
-
-div.sectionbody {
-  font-family: serif;
-  margin-left: 0;
-}
-
-hr {
-  border: 1px solid silver;
-}
-
-p {
-  margin-top: 0.5em;
-  margin-bottom: 0.5em;
-}
-
-ul, ol, li > p {
-  margin-top: 0;
-}
-
-pre {
-  padding: 0;
-  margin: 0;
-}
-
-span#author {
-  color: #527bbd;
-  font-family: sans-serif;
-  font-weight: bold;
-  font-size: 1.1em;
-}
-span#email {
-}
-span#revision {
-  font-family: sans-serif;
-}
-
-div#footer {
-  font-family: sans-serif;
-  font-size: small;
-  border-top: 2px solid silver;
-  padding-top: 0.5em;
-  margin-top: 4.0em;
-}
-div#footer-text {
-  float: left;
-  padding-bottom: 0.5em;
-}
-div#footer-badges {
-  float: right;
-  padding-bottom: 0.5em;
-}
-
-div#preamble,
-div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
-div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
-div.admonitionblock {
-  margin-right: 10%;
-  margin-top: 1.5em;
-  margin-bottom: 1.5em;
-}
-div.admonitionblock {
-  margin-top: 2.5em;
-  margin-bottom: 2.5em;
-}
-
-div.content { /* Block element content. */
-  padding: 0;
-}
-
-/* Block element titles. */
-div.title, caption.title {
-  color: #527bbd;
-  font-family: sans-serif;
-  font-weight: bold;
-  text-align: left;
-  margin-top: 1.0em;
-  margin-bottom: 0.5em;
-}
-div.title + * {
-  margin-top: 0;
-}
-
-td div.title:first-child {
-  margin-top: 0.0em;
-}
-div.content div.title:first-child {
-  margin-top: 0.0em;
-}
-div.content + div.title {
-  margin-top: 0.0em;
-}
-
-div.sidebarblock > div.content {
-  background: #ffffee;
-  border: 1px solid silver;
-  padding: 0.5em;
-}
-
-div.listingblock {
-  margin-right: 0%;
-}
-div.listingblock > div.content {
-  border: 1px solid silver;
-  background: #f4f4f4;
-  padding: 0.5em;
-}
-
-div.quoteblock {
-  padding-left: 2.0em;
-}
-div.quoteblock > div.attribution {
-  padding-top: 0.5em;
-  text-align: right;
-}
-
-div.verseblock {
-  padding-left: 2.0em;
-}
-div.verseblock > div.content {
-  white-space: pre;
-}
-div.verseblock > div.attribution {
-  padding-top: 0.75em;
-  text-align: left;
-}
-/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
-div.verseblock + div.attribution {
-  text-align: left;
-}
-
-div.admonitionblock .icon {
-  vertical-align: top;
-  font-size: 1.1em;
-  font-weight: bold;
-  text-decoration: underline;
-  color: #527bbd;
-  padding-right: 0.5em;
-}
-div.admonitionblock td.content {
-  padding-left: 0.5em;
-  border-left: 2px solid silver;
-}
-
-div.exampleblock > div.content {
-  border-left: 2px solid silver;
-  padding: 0.5em;
-}
-
-div.imageblock div.content { padding-left: 0; }
-div.imageblock img { border: 1px solid silver; }
-span.image img { border-style: none; }
-
-dl {
-  margin-top: 0.8em;
-  margin-bottom: 0.8em;
-}
-dt {
-  margin-top: 0.5em;
-  margin-bottom: 0;
-  font-style: normal;
-}
-dd > *:first-child {
-  margin-top: 0.1em;
-}
-
-ul, ol {
-    list-style-position: outside;
-}
-div.olist > ol {
-  list-style-type: decimal;
-}
-div.olist2 > ol {
-  list-style-type: lower-alpha;
-}
-
-div.tableblock > table {
-  border: 3px solid #527bbd;
-}
-thead {
-  font-family: sans-serif;
-  font-weight: bold;
-}
-tfoot {
-  font-weight: bold;
-}
-
-div.hlist {
-  margin-top: 0.8em;
-  margin-bottom: 0.8em;
-}
-div.hlist td {
-  padding-bottom: 15px;
-}
-td.hlist1 {
-  vertical-align: top;
-  font-style: normal;
-  padding-right: 0.8em;
-}
-td.hlist2 {
-  vertical-align: top;
-}
-
-@media print {
-  div#footer-badges { display: none; }
-}
-
-div#toctitle {
-  color: #527bbd;
-  font-family: sans-serif;
-  font-size: 1.1em;
-  font-weight: bold;
-  margin-top: 1.0em;
-  margin-bottom: 0.1em;
-}
-
-div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
-  margin-top: 0;
-  margin-bottom: 0;
-}
-div.toclevel2 {
-  margin-left: 2em;
-  font-size: 0.9em;
-}
-div.toclevel3 {
-  margin-left: 4em;
-  font-size: 0.9em;
-}
-div.toclevel4 {
-  margin-left: 6em;
-  font-size: 0.9em;
-}
-/* Workarounds for IE6's broken and incomplete CSS2. */
-
-div.sidebar-content {
-  background: #ffffee;
-  border: 1px solid silver;
-  padding: 0.5em;
-}
-div.sidebar-title, div.image-title {
-  color: #527bbd;
-  font-family: sans-serif;
-  font-weight: bold;
-  margin-top: 0.0em;
-  margin-bottom: 0.5em;
-}
-
-div.listingblock div.content {
-  border: 1px solid silver;
-  background: #f4f4f4;
-  padding: 0.5em;
-}
-
-div.quoteblock-attribution {
-  padding-top: 0.5em;
-  text-align: right;
-}
-
-div.verseblock-content {
-  white-space: pre;
-}
-div.verseblock-attribution {
-  padding-top: 0.75em;
-  text-align: left;
-}
-
-div.exampleblock-content {
-  border-left: 2px solid silver;
-  padding-left: 0.5em;
-}
-
-/* IE6 sets dynamically generated links as visited. */
-div#toc a:visited { color: blue; }
-
-/* Because IE6 child selector is broken. */
-div.olist2 ol {
-  list-style-type: lower-alpha;
-}
-div.olist2 div.olist ol {
-  list-style-type: decimal;
-}
-</style>
-<title>git2cl</title>
-</head>
-<body>
-<div id="header">
-<h1>git2cl</h1>
-</div>
-<div id="preamble">
-<div class="sectionbody">
-<div class="para"><p>This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
-format.</p></div>
-<div class="para"><p>The tool invokes <em>git log</em> internally unless you pipe a log to it.
-Thus, typically you would use it as follows:</p></div>
-<div class="literalblock">
-<div class="content">
-<pre><tt>jas@mocca:~/src/libtasn1$ git2cl &gt; ChangeLog
-jas@mocca:~/src/libtasn1$</tt></pre>
-</div></div>
-<div class="para"><p>If you don't want git2cl to invoke git log internally, you can use it
-as a pipe.  It needs a git log generated with &#8212;pretty &#8212;numstat and
-&#8212;summary.  You can use it as follows:</p></div>
-<div class="literalblock">
-<div class="content">
-<pre><tt>jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl &gt; ChangeLog
-jas@mocca:~/src/libtasn1$</tt></pre>
-</div></div>
-<div class="para"><p>The output format is specified by:</p></div>
-<div class="para"><p><a href="http://www.gnu.org/prep/standards/html_node/Change-Logs.html">http://www.gnu.org/prep/standards/html_node/Change-Logs.html</a></p></div>
-<div class="para"><p>My inspiration for writing this tool was the
-<a href="http://www.red-bean.com/cvs2cl/">cvs2cl</a> tool, which I have been
-using in several projects.  Replacing it was necessary to seriously
-consider switching from CVS to GIT for my projects.</p></div>
-<div class="para"><p>The canonical home page for git2cl is:
-<a href="http://josefsson.org/git2cl/">http://josefsson.org/git2cl/</a> and its repository can be found at
-<a href="http://repo.or.cz/w/git2cl.git">http://repo.or.cz/w/git2cl.git</a>.</p></div>
-</div>
-</div>
-<h2 id="_credits">Credits</h2>
-<div class="sectionbody">
-<div class="para"><p>Luis Mondesi contributed several improvements.</p></div>
-</div>
-<h2 id="_support">Support</h2>
-<div class="sectionbody">
-<div class="para"><p>Try talking to <a href="mailto:simon@josefsson.org">Simon Josefsson</a>.</p></div>
-</div>
-<div id="footer">
-<div id="footer-text">
-Last updated 2008-08-27 12:42:17 CEST
-</div>
-</div>
-</body>
-</html>
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..957399d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# git2cl
+
+Convert `git` logs to GNU ChangeLog format.
+
+# License
+
+The git2cl tool is released under the GPLv2+.  See the file
+[COPYING](COPYING) for detailed information.
+
+# Usage
+
+The tool invokes 'git log' internally unless you pipe a log to it.
+Thus, typically you would use it as follows:
+
+```
+jas@mocca:~/src/libtasn1$ git2cl > ChangeLog
+jas@mocca:~/src/libtasn1$
+```
+
+If you don't want git2cl to invoke git log internally, you can use it
+as a pipe.  It needs a git log generated with --pretty --numstat and
+--summary.  You can use it as follows:
+
+```
+jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | git2cl > ChangeLog
+jas@mocca:~/src/libtasn1$
+```
+
+The output format is specified by the [GNU ChangeLog
+format](http://www.gnu.org/prep/standards/html_node/Change-Logs.html).
+
+My inspiration for writing this tool was the
+[cvs2cl](http://www.red-bean.com/cvs2cl/) tool, which I have been
+using in several projects.  Replacing it was necessary to seriously
+consider switching from CVS to GIT for my projects.
+
+There is a [Savannah git2cl
+project](https://savannah.nongnu.org/projects/git2cl/) and a [GitLab
+git2cl project](https://gitlab.com/jas/git2cl). An old repository is
+still at [http://repo.or.cz/w/git2cl.git].
+
+# Credits
+
+Luis Mondesi contributed several improvements.
+
+# Support
+
+Try talking to [simon@josefsson.org](Simon Josefsson).
author	Simon Josefsson <simon@josefsson.org>	2024-10-09 14:32:14 +0200
committer	Simon Josefsson <simon@josefsson.org>	2024-10-09 14:41:10 +0200
commit	1599415916e95172d4935030c68ec59d744cbf49 (patch)
tree	6bf32f4193ddabf0361ee6fade5f8ed63db2ef18
parent	009e602f240b40ac4bf6b94a65e92c0efe86a700 (diff)
download	git2cl-1599415916e95172d4935030c68ec59d744cbf49.zip git2cl-1599415916e95172d4935030c68ec59d744cbf49.tar.gz git2cl-1599415916e95172d4935030c68ec59d744cbf49.tar.bz2