git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Yann Droneaud <ydroneaud@opteya.com>
To: Git <git@vger.kernel.org>
Cc: Yann Droneaud <ydroneaud@opteya.com>
Subject: [PATCH] Documentation: add a README file
Date: Thu, 21 Mar 2013 14:45:55 +0100	[thread overview]
Message-ID: <1363873555-8274-1-git-send-email-ydroneaud@opteya.com> (raw)

The documentation is in AsciiDoc format: it should be written somewhere
with links to AsciiDoc documentation so that it became easy to find
how to write documentation for Git.

Signed-off-by: Yann Droneaud <ydroneaud@opteya.com>
---
 Documentation/README | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 Documentation/README

diff --git a/Documentation/README b/Documentation/README
new file mode 100644
index 0000000..c41734c
--- /dev/null
+++ b/Documentation/README
@@ -0,0 +1,13 @@
+Documentation
+=============
+
+Most of the Git documentation is in AsciiDoc format,
+a lightweight markup text language.
+
+AsciiDoc formatted files can be translated to man pages,
+HTML, DocBook or PDF documents.
+
+See:
+- http://asciidoc.org/
+- https://git.wiki.kernel.org/index.php/AsciiDoc
+
-- 
1.7.11.7

             reply	other threads:[~2013-03-21 13:46 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-03-21 13:45 Yann Droneaud [this message]
2013-03-21 15:31 ` [PATCH] Documentation: add a README file Junio C Hamano
2013-03-21 15:49   ` Yann Droneaud
2013-03-21 17:39     ` Junio C Hamano
2013-03-21 21:16       ` Junio C Hamano
2013-03-21 22:02         ` Yann Droneaud
2013-03-21 21:59       ` Yann Droneaud
2013-03-21 22:09         ` Jonathan Nieder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1363873555-8274-1-git-send-email-ydroneaud@opteya.com \
    --to=ydroneaud@opteya.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).