Readme for examples folder.

Author: ReFreezed

examples/README.md

@@ -0,0 +1,13 @@
+# Examples
+
+`*.lua2p` files are the unprocessed source files.
+`*.output.lua` files show the processed output / final program.
+
+| File | Description
+| ---- | -----------
+| [dualCode.lua2p](dualCode.lua2p)                             | Shows how you can declare variables in the metaprogram and final program at the same time. (`!!x=y`)
+| [macros.lua2p](macros.lua2p)                                 | Shows how macros can be used to enhance code. (`@insert func()`)
+| [namedConstants.lua2p](namedConstants.lua2p)                 | Shows how you can use variables in the metaprogram to output literals into the final program. (`!()`)
+| [optimizeDataAccess.lua2p](optimizeDataAccess.lua2p)         | Shows how you could make data access in the final program more efficient.
+| [parseFile.lua2p](parseFile.lua2p)                           | Shows how you can perform a computationally expensive operation at build time instead of every time at runtime.
+| [selectiveFunctionality.lua2p](selectiveFunctionality.lua2p) | Shows how parts of the code can be excluded from the final program using variables in the metaprogram.

examples/dualCode.output.lua

@@ -9,8 +9,10 @@
 
 -- Assignments starting with !! will appear in both the metaprogram and the final output.
 local TEXT_HEIGHT    = 30
+
 local BUTTON_PADDING = 15
 local BUTTON_BORDER  = 2
+
 local BUTTON_WIDTH   = 400
 local BUTTON_HEIGHT  = 64
 

examples/macros.lua2p

@@ -43,4 +43,7 @@ assert(i > 1 and i < 7, "Invalid index. It must be 1<=i<=7 but is "..i)
 -- itself in the message.
 @insert assert(i > 1 and i < 7)
 
+-- Note that @insert can also be written as @@.
+@@assert(i > 1 and i < 7)
+
 print("'i' is all good!")

examples/macros.output.lua

@@ -28,4 +28,7 @@ if not (i > 1 and i < 7) then  error("Invalid index. It must be 1<=i<=7 but is "
 -- itself in the message.
 if not (i > 1 and i < 7) then  error("Assertion failed: i > 1 and i < 7")  end
 
+-- Note that @insert can also be written as @@.
+if not (i > 1 and i < 7) then  error("Assertion failed: i > 1 and i < 7")  end
+
 print("'i' is all good!")

examples/optimizeDataAccess.lua2p

@@ -51,9 +51,11 @@ CHARACTERS_UNLOCKED_BY_DEFAULT = {
 	!end
 }
 
+--
 -- Instead of iterating over the CHARACTERS array until we find
 -- the character with the specified ID, we use the maps above to
 -- get the information we want through a single table lookup.
+--
 function getCharacterName(charId)
 	return CHARACTER_NAMES[charId]
 end

examples/optimizeDataAccess.output.lua

@@ -45,9 +45,11 @@ CHARACTERS_UNLOCKED_BY_DEFAULT = {
 	dev = true,
 }
 
+--
 -- Instead of iterating over the CHARACTERS array until we find
 -- the character with the specified ID, we use the maps above to
 -- get the information we want through a single table lookup.
+--
 function getCharacterName(charId)
 	return CHARACTER_NAMES[charId]
 end