diff --git a/chapters/releasing.md b/chapters/releasing.md index c9dd8e1..48dc6eb 100644 --- a/chapters/releasing.md +++ b/chapters/releasing.md @@ -88,34 +88,7 @@ You should provide a readme file. This should state: * What dependencies there are / what the user needs to install. * Where to report problems/bugs or get help. -Example: - - My Super Special Mod - ==================== - - Adds magic, rainbows and other special things. - - Version: 1.1 - License: LGPL 2.1 or later - - Dependencies: default mod (found in minetest_game) - - Report bugs or request help on the forum topic. - - Installation - ------------ - - Unzip the archive, rename the folder to to modfoldername and - place it in minetest/mods/minetest/ - - ( GNU/Linux: If you use a system-wide installation place - it in ~/.minetest/mods/minetest/. ) - - ( If you only want this to be used in a single world, place - the folder in worldmods/ in your worlddirectory. ) - - For further information or help see: - http://wiki.minetest.com/wiki/Installing_Mods +See appendix for an example and a generator ### description.txt @@ -256,3 +229,150 @@ Subject of topic must be in one of these formats: Profit + +## Appendix: Readme and Forum Generator + + + +Title:
+Modname:
+Description:
+Version:
+License:
+Dependencies:
+Download:
+Additional:
+
+ +
My Super Special Mod
+====================
+
+Adds magic, rainbows and other special things.
+
+Version: 1.1
+License: LGPL 2.1 or later
+Dependencies: default mod (found in minetest_game)
+
+Report bugs or request help on the forum topic.
+
+Installation
+------------
+
+Unzip the archive, rename the folder to mysuperspecial and
+place it in minetest/mods/
+
+(  GNU/Linux: If you use a system-wide installation place
+	it in ~/.minetest/mods/.  )
+
+(  If you only want this to be used in a single world, place
+	the folder in worldmods/ in your worlddirectory.  )
+
+For further information or help see:
+http://wiki.minetest.com/wiki/Installing_Mods
+ +
Adds magic, rainbows and other special things.
+
+[b]Version:[/b] 1.1
+[b]License:[/b] LGPL 2.1 or later
+[b]Dependencies:[/b] default mod (found in minetest_game)
+[b]Download:[/b] http://example.com/download.zip
+
+Report bugs or request help on the forum topic.
+
+[h]Installation[/h]
+
+Unzip the archive, rename the folder to mysuperspecial and
+place it in minetest/mods/
+
+(  GNU/Linux: If you use a system-wide installation place
+	it in ~/.minetest/mods/.  )
+
+(  If you only want this to be used in a single world, place
+	the folder in worldmods/ in your worlddirectory.  )
+
+For further information or help see:
+http://wiki.minetest.com/wiki/Installing_Mods
+ + +