summaryrefslogtreecommitdiffstats
path: root/doc/misc/README.handbook
diff options
context:
space:
mode:
authorgregory guy <[email protected]>2020-02-22 12:31:47 +0100
committerMichele Calgaro <[email protected]>2020-02-23 15:34:03 +0900
commit77cd84aae90b8d04f56dfb5b738a58900cd4c0cc (patch)
tree6d5d20934590afbda5e278bdbe27d73a7ca2006d /doc/misc/README.handbook
parenta5b1b4e3e2c717ae1d392fdf37d7ac0d1f77c51d (diff)
downloadkvpnc-77cd84aae90b8d04f56dfb5b738a58900cd4c0cc.tar.gz
kvpnc-77cd84aae90b8d04f56dfb5b738a58900cd4c0cc.zip
Drop automake build support.
Add basic build instructions. Rework of the README, INSTALL and help page. Remove empty folder templates and the NEWS file. Delete the INSTALL.debian and INSTALL.gentoo files. Create the doc/misc folder to hold lot of config and/or readme files. Signed-off-by: gregory guy <[email protected]> (cherry picked from commit 9b99335373bb5e06cfb2cdbbff4f6d45b3d0edda)
Diffstat (limited to 'doc/misc/README.handbook')
-rw-r--r--doc/misc/README.handbook14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/misc/README.handbook b/doc/misc/README.handbook
new file mode 100644
index 0000000..71395af
--- /dev/null
+++ b/doc/misc/README.handbook
@@ -0,0 +1,14 @@
+How to write the handbook
+-------------------------
+
+
+Step 1: write your content in English in index.docbook (maybe multiple files with xinclude)
+Step 2: run './update_handbook.sh' in this directory. This will update english translation template (handbook.pot) and all translations (e.g. fr/handbook.po)
+Step 3: translate <yourlanguage>/handbook.po (if your language isnt there yet, grab handbook.pot and send to me)
+Step 4: run './update_handbook.sh' again. This will create the docbook files containing the translation
+
+Best regards
+
+Christoph <[email protected]>
+
+Last change: 2005/19/09