rename ldoc readme files folder

rename ldoc configuration file
remove ldoc examples
add readme for ldoc generation
make sure tengine_doc isn't included with git

.gitignore

@@ -11,4 +11,4 @@ out.avi
 out.ogv
 te4_log_web.txt
 t-engine
-documentation/*_doc
\ No newline at end of file
+tengine_doc
\ No newline at end of file

documentation/README

+Building
+========
+Building the documentation requires [LDoc](https://github.com/stevedonovan/LDoc)  
+It has a dependency of [Penlight](https://github.com/stevedonovan/Penlight)  
+And optionally you can install [lua-discount](https://github.com/craigbarnes/lua-discount) for better markdown processing of comments  
+
+Both dependencies can be found with luarocks if you have that
+
+Just point ldoc.lua at the directory this README file is contained in and it will handle the rest:
+	t-engine-source $ cd documentation
+	t-engine-source/documentation $ lua /path/to/ldoc.lua .
+
+After building the documentation, it will output into `tengine_doc` one directory below
+You can alter this path by including `-d path` when calling ldoc
\ No newline at end of file

documentation/tengine.ld → documentation/config.ld

 project='T-Engine 4 v1.4.0'
 title='TE4 1.4.0 Documentation'
 description='Documentation for T-Engine 4 - version 1.4.0'
-examples = {'examples'}
-file={'../game/engines/default/engine', '../game/engines/default/data', 'readme'}
+file={'../game/engines/default/engine', '../game/engines/default/data', 'readme_files'}
 kind_names={topic='Manual'}
 style='!fixed'
 all=true
@@ -11,11 +10,11 @@ sort=false
 package=engine
 merge=true
 format = 'discount'
-readme={'readme'}
+readme={'readme_files'}
 convert_opt=true
 custom_tags={"inherit","Inherits"}
 style='style'
 template='style'
-dir='tengine_doc'
+dir='../tengine_doc'
 full_description=[[<a href="manual/index.md.html">View the Manual</a> | <a href="http://git.net-core.org/tome/t-engine4/">T-Engine Git Repository</a>
 ]]

documentation/examples/birth_descriptor.lua

---- Return to @{engine.Birther.newBirthDescriptor}
-newBirthDescriptor{
-	type = "base",
-	name = "base",
-	desc = {
-	},
-	descriptor_choices =
-	{
-		world =
-		{
-			["Maj'Eyal"] = "allow",
-			Infinite = "allow",
-			Arena = "allow",
-		},
-		class =
-		{
-			-- Specific to some races
-			None = "disallow",
-		},
-	},
-	talents = {},
-	experience = 1.0,
-	body = { INVEN = 1000, QS_MAINHAND = 1, QS_OFFHAND = 1, MAINHAND = 1, OFFHAND = 1, FINGER = 2, NECK = 1, LITE = 1, BODY = 1, HEAD = 1, CLOAK = 1, HANDS = 1, BELT = 1, FEET = 1, TOOL = 1, QUIVER = 1, QS_QUIVER = 1 },
-
-	copy = {
-		-- Some basic stuff
-		move_others = true,
-		no_auto_resists = true, no_auto_saves = true,
-		no_auto_high_stats = true,
-		resists_cap = {all=70},
-		keep_inven_on_death = true,
-		can_change_level = true,
-		can_change_zone = true,
-		save_hotkeys = true,
-
-		-- Mages are unheard of at first, nobody but them regenerates mana
-		mana_rating = 6,
-		mana_regen = 0,
-
-		max_level = 50,
-		money = 15,
-		resolvers.equip{ id=true,
-			{type="lite", subtype="lite", name="brass lantern", ignore_material_restriction=true, ego_chance=-1000},
-		},
-		make_tile = function(e)
-			if not e.image then e.image = "player/"..e.descriptor.subrace:lower():gsub("[^a-z0-9_]", "_").."_"..e.descriptor.sex:lower():gsub("[^a-z0-9_]", "_")..".png" end
-		end,
-	},
-	game_state = {
-		force_town_respec = 1,
-	}
-}
\ No newline at end of file

documentation/readme/index.md

-# T-Engine 4 Manual
-
-## External Information
-* <a href="http://www.lua.org/manual/5.1/index.html">Lua 5.1 manual</a>
-* <a href="http://lua-users.org/wiki/LuaDirectory">Lua Users Wiki</a>
-* <strong>IRC:</strong> <code>irc.rizon.net #tome</code>
-
-
-## Topics
-* @{colors.md|Understanding the COLOR System}
-
-## Generic Examples
-* @{birth_descriptor.lua|Birth Descriptor}
\ No newline at end of file

documentation/readme_files/index.md

+# T-Engine 4 Manual
+
+## External Information
+*   <a href="http://www.lua.org/manual/5.1/index.html">Lua 5.1 manual</a>
+*   <a href="http://lua-users.org/wiki/LuaDirectory">Lua Users Wiki</a>
+*   <strong>IRC:</strong> <code>irc.rizon.net #tome</code>
+
+## Topics
+* @{colors.md|Understanding the COLOR System}
\ No newline at end of file