pve-admin-guide.adoc: remove preface tag

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index c5cec413f23103d72e996389de5efd61065976b4..7907228a13625450cecb50bc1de30a62a23eb819 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -5,17 +5,32 @@ 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').
+
+Autogenerated CLI Command Synopsis
+----------------------------------
+
+We generate the command line synopsis for all manual pages
+automatically. We can do that, because we have a full declarative
+definition of the {pve} API. I added those generated files
+('*-synopsis.adoc') to the git repository, so that it is possible to
+build the documentation without having a fully installed {pve}
+development environment.
 
 Copyright
 ---------
 
-Copyright (C) Proxmox Server Solutions Gmbh
+Copyright (C) 2016 Proxmox Server Solutions Gmbh
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
 any later version published by the Free Software Foundation; with no
-Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
-copy of the license is included in the section entitled "GNU Free
-Documentation License".
+Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+copy of the license is included in the link:LICENSE[LICENSE] file.