Updated docs

There is still stuff to do

docs/objects/Basalt/autoUpdate.md

@@ -0,0 +1,13 @@
+## basalt.autoUpdate
+This starts the event and draw handler for you. The listeners will run until you stop them.
+
+#### Parameters: 
+1. `boolean` optional - if you use false as the first parameter it would stop the listeners.
+
+#### Usage:
+* Enable the basalt listeners, otherwise the screen will not continue to update
+```lua
+local main = basalt.createFrame()
+
+basalt.autoUpdate()
+```

docs/objects/Basalt/createFrame.md

@@ -0,0 +1,27 @@
+## basalt.createFrame
+Creates a new base-frame, you can have as many base-frames as you want, but only 1 can be active (visible) at the same time.
+You can always switch between your base frames.
+
+Only the currently active base-frame listens to incoming events (except for some events like time-events and peripheral-events)
+
+#### Parameters: 
+1. `string` id - optional (if you dont set a id it will automatically create a uuid for you)
+
+#### Returns: 
+1. `frame` object
+
+#### Usage:
+* How to use multiple base frames:
+```lua
+local main1 = basalt.createFrame() -- Visible base frame on program start
+local main2 = basalt.createFrame()
+local main3 = basalt.createFrame()
+main1:addButton()
+    :setPosition(2,2)
+    :setText("Switch")
+    :onClick(function()
+        main2:show() -- this function automatically "hides" the first one and shows the second one
+    end)
+main2:addLabel()
+    :setText("We are currently on main2")
+```

docs/objects/Basalt/debug.md

@@ -0,0 +1,22 @@
+## basalt.debug
+Creates a label with some information on the main frame on the bottom left. When you click on that label it will open a log view for you. See it as the new print for debugging
+
+You can also edit the default debug Label (change position, change color or whatever you want) by accessing the variable basalt.debugLabel
+which returns the debug Label.
+
+Also basalt.debugFrame and basalt.debugList are available.
+
+#### Parameters: 
+1. `...` (multiple parameters are possible, like print does)
+
+#### Usage:
+* Prints "Hello! ^-^" to the debug console
+```lua
+basalt.debug("Hello! ", "^-^")
+```
+
+* Changes the debug label's anchor
+```lua
+basalt.debugLabel:setAnchor("topLeft") -- default anchor is bottomLeft
+basalt.debug("Hello!")
+```

docs/objects/Basalt/getActiveFrame.md

@@ -0,0 +1,12 @@
+## basalt.getActiveFrame
+Returns the currently active/visible base frame
+
+#### Returns: 
+1. `frame` The current frame
+
+#### Usage:
+* Displays the active frame name in the debug console
+```lua
+local main = basalt.createFrame()
+basalt.debug(basalt.getActiveFrame():getName()) -- returns the id
+```

docs/objects/Basalt/getFrame.md

@@ -0,0 +1,23 @@
+## basalt.getFrame
+Returns a base frame by the given id
+
+#### Parameters: 
+1. `string` id
+
+#### Returns: 
+1. `frame` object
+
+#### Usage:
+* Creates, fetches and shows the "myFirstFrame" object
+```lua
+local main = basalt.createFrame("firstBaseFrame")
+local main2 = basalt.createFrame("secondBaseFrame")
+main:addButton()
+    :setText("Show")
+    :onClick(function()
+        local frame2 = basalt.getFrame("secondBaseFrame")
+        if(frame2~=nil)then
+            frame2:show()
+        end
+    end)
+```

docs/objects/Basalt/isKeyDown.md

@@ -0,0 +1,21 @@
+## basalt.isKeyDown
+Checks if the user is currently holding a key
+
+#### Parameters: 
+1. `number` key code (use the keys table for that)
+
+#### Returns: 
+1. `boolean` true or false
+
+#### Usage:
+* Shows a debug message with true or false if the left ctrl key is down, as soon as you click on the button.
+```lua
+local main = basalt.createFrame()
+local aButton = mainFrame:addButton()
+    :setPosition(2,2)
+    :setText("Check Ctrl")
+    :onClick(function() 
+        basalt.debug(basalt.isKeyDown(keys.leftCtrl))
+    end)
+basalt.autoUpdate()
+```

docs/objects/Basalt/log.md

@@ -0,0 +1,15 @@
+## basalt.log
+This writes something into a file. The main goal is to make debugging errors easier. Lets say you'r program is crashing and
+you don't know why, you could use basalt.log
+
+The log files will automatically removed after you start your program again
+
+#### Parameters: 
+1. `string` The text to write into the log file
+2. `string` - optional (default: "Debug") - the type to write
+
+#### Usage:
+* Writes "Hello!" into the log file
+```lua
+basalt.log("Hello!")
+```

docs/objects/Basalt/removeFrame.md

@@ -0,0 +1,17 @@
+## basalt.removeFrame
+Removes the base frame by it's id. This only works for base-frames.
+
+#### Parameters: 
+1. `string` id
+
+#### Usage:
+* Removes the previously created frame with id "myFirstFrame" 
+```lua
+local main = basalt.createFrame("firstBaseFrame")
+local main2 = basalt.createFrame("secondBaseFrame")
+main:addButton()
+    :setText("Remove")
+    :onClick(function()
+        basalt.removeFrame(main2:getName()) -- you can use main2:getName() to find out the id or just use "secondBaseFrame"
+    end)
+```

docs/objects/Basalt/schedule.md

@@ -0,0 +1,28 @@
+## basalt.schedule
+Schedules a function which gets called in a coroutine. After the coroutine is finished it will get destroyed immediatly. It's something like threads, but with some limits.
+
+#### Parameters: 
+1. `function` a function which should get executed
+
+#### Returns: 
+1. `function` it returns the function which you have to execute in order to start the coroutine
+
+#### Usage:
+* Creates a schedule which switches the color between red and gray
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setText("Click me")
+aButton:onClick(basalt.schedule(function(self)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+    os.sleep(0.1)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+    os.sleep(0.1)
+    self:setBackground(colors.red)
+    os.sleep(0.1)
+    self:setBackground(colors.gray)
+end))
+```

docs/objects/Basalt/setTheme.md

@@ -0,0 +1,15 @@
+## basalt.setTheme
+Sets the base theme of the project! Make sure to cover all existing objects, otherwise it will result in errors. A good example is [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua)
+
+#### Parameters: 
+1. `table` theme layout look into [theme](https://github.com/Pyroxenium/Basalt/blob/master/Basalt/theme.lua) for a example
+
+#### Usage:
+* Sets the default theme of basalt.
+```lua
+basalt.setTheme({
+    ButtonBG = colors.yellow,
+    ButtonText = colors.red,
+    ...,
+})
+```

docs/objects/Basalt/setVariable.md

@@ -0,0 +1,17 @@
+## basalt.setVariable
+This stores a variable which you're able to access via xml. You are also able to add a function, which then gets called by object events created in XML.
+
+#### Parameters: 
+1. `string` a key name
+1. `any` any variable
+
+#### Usage:
+* Adds a function to basalt.
+```lua
+basalt.setVariable("clickMe", function()
+    basalt.debug("I got clicked")
+end)
+```
+```xml
+<button onClick="clickMe" text="Click me" />
+```

docs/objects/Basalt/stopUpdate.md

@@ -0,0 +1,15 @@
+## basalt.stopUpdate or basalt.stop
+Stops the automatic draw and event handler which got started by basalt.autoUpdate()
+
+#### Usage:
+* When the quit button is clicked, the button stops basalt's event listeners and draw handlers
+```lua
+local main = basalt.createFrame()
+local aButton = main:addButton()
+    :setPosition(2,2)
+    :setText("Stop Basalt!")
+    :onClick(function()
+        basalt.stopUpdate()
+    end)
+basalt.autoUpdate()
+```

docs/objects/Basalt/update.md

@@ -0,0 +1,18 @@
+## basalt.update
+Calls the draw and event handler once - this gives more flexibility about which events basalt should process. For example you could filter the terminate event.
+Which means you have to pass the events into basalt.update.
+
+#### Parameters: 
+1. `string` The event to be received 
+2. `...` Additional event variables to capture
+
+#### Usage:
+* Creates and starts a custom update cycle
+```lua
+local mainFrame = basalt.createFrame()
+local aButton = mainFrame:addButton():setPosition(2,2)
+while true do
+    local ev = table.pack(os.pullEventRaw())
+    basalt.update(table.unpack(ev))
+end
+```