summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorClement Lefebvre <[email protected]>2015-09-08 16:10:04 +0100
committerClement Lefebvre <[email protected]>2015-09-08 16:36:43 +0100
commita50fc3dcb90f3180e8fe4f4acdf133db1e0cdbdf (patch)
treedc190fc67b3d26e80dd6f58b70a7cb031ec3a5c4 /HACKING
parentf63ecf7699e566fb3e445110b01e36d793b42b28 (diff)
downloadmate-user-guide-a50fc3dcb90f3180e8fe4f4acdf133db1e0cdbdf.tar.bz2
mate-user-guide-a50fc3dcb90f3180e8fe4f4acdf133db1e0cdbdf.tar.xz
Ported mate-desktop/user-guide to mate-user-guide
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING43
1 files changed, 43 insertions, 0 deletions
diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..3970b46
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,43 @@
+mate-user-guide
+===============
+
+This module is for end-user documents with general MATE applicability
+only. It will be shipped as the mate-user-guide package. It is possible
+that "Help" and or links to individaul packages/modules/applications will show
+up here as well.
+
+
+Documentation for Doc Writers/Contributors
+-----------------------------
+
+For help on editing documentation, see the following pages:
+http://wiki.mate-desktop.org/dev-doc
+
+If you want to hack on the documentation, don't forget to Join the MATE
+Documentation Project:
+http://wiki.mate-desktop.org/dev-doc
+
+Please do not forget to check the status here:
+http://wiki.mate-desktop.org/status:doc-team
+
+Any file that is edited needs to have the following in the header below the
+<revision...> tag, above any similiar entries, preferably separated by a blank
+line on both sides. Of course your own entry may go directly beneath this one,
+with an <email> tag if desired:
+
+ <credit type="author">
+ <name>Mate Documentation Team</name>
+ </credit>
+
+Directory Structure
+-------------------
+
+Please respect the directory structure:
+ mate-user-guide/<docname>/C/<docname>.page(stub,tmpl)
+ mate-user-guide/<docname>/C/figures/
+ mate-user-guide/<docname>/C/template/
+
+In some cases, it may make sense to nest things one level deeper. However,
+do not nest things less deep.
+
+The entire MATE Development Team appreciates your help and interest.