update mediawiki README

[pve-docs.git] / README.adoc

diff --git a/README.adoc b/README.adoc
index 7e7431ad91fd73fdad17e0c7eac13e76edb9f13b..ed031141cf3e1be4673fefb1683750383cea542e 100644 (file)
--- a/README.adoc
+++ b/README.adoc
@@ -16,14 +16,30 @@ When possible, we provide scripts to extract API definitions,
 configuration or command line options from the source code.
 
 To simplify the documentation task, we keep all Documentation within
-this repository. It is possible to generate the docs (without installing
-any additional Proxmox packages) with:
+this repository. It is possible to generate the docs without installing
+any additional Proxmox packages with:
 
- make index.html
+ make index
 
-We also generate an additional development package called
-'pve-doc-generator', which is used by other Proxmox VE package to
-generate manual pages at package build time.
+To update the auto-generate API definitions use:
+
+ make update
+
+NOTE: you need a fully installed development environment for that.
+
+
+Debian Packages
+---------------
+
+We generate a development package called 'pve-doc-generator', which is
+used by other Proxmox VE package to generate manual pages at package
+build time.
+
+Another package called 'pve-docs' is used to publish generated
+'.html' and '.pdf' files on our web servers. You can generate
+those debian packages using:
+
+ make deb
 
 
 Common Macro definition in link:attributes.txt[]