add ideas to README
authorDietmar Maurer <dietmar@proxmox.com>
Tue, 5 Jan 2016 11:15:13 +0000 (12:15 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Tue, 5 Jan 2016 11:15:13 +0000 (12:15 +0100)
README.adoc

index c5cec41..a24c9dc 100644 (file)
@@ -5,7 +5,14 @@ What is this?
 -------------
 
 This is an experimental project, trying to generate high quality
-documentation for http://www.proxmox.com[Proxmox VE].
+documentation for http://www.proxmox.com[Proxmox VE]. We choose to use
+http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
+
+One idea is to generate high quality manual pages, and assemble them
+into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
+Administration Guide].  So we have one source, and generate several
+documents from that. It is also possible to generate printable PDF
+files, or ebook formats ('.ebup').
 
 
 Copyright