Create README.md

This will need amending later

windont/README.md

@@ -0,0 +1,87 @@
+# Windon't
+
+### A replacement for the Window API, created by someone who can't think of better names
+
+To load Windon't, simply use `require` or `dofile`.
+
+```lua
+local windont = dofile("path/to/windont.lua")
+```
+
+Windon't contains two functions: one to make a new window object, and another to render them.
+Beyond that, Windon't stores various default values that are used when creating new windows.
+
+```lson
+windont.default = {
+	baseTerm = term.current(),	-- default base terminal for all windows
+	textColor = "0",		-- default text color (what " " corresponds to in term.blit's second argument)
+	backColor = "f",		-- default background color (what " " corresponds to in term.blit's third argument)
+	blink = true,			-- default getCursorBlink
+	visible = true,			-- default whether or not new windows are visible
+	alwaysRender = true,		-- if true, new windows will always render if they are written to
+}
+```
+
+### windont.newWindow
+```
+windont.newWindow(number x, number y, number width, number height, table miscData)
+```
+Creates a new window located at (`x`, `y`), with the specified `width` and `height`.	
+By default, the base terminal used will be `windont.default.baseTerm`, which is normally set to `term.current()`.
+"Windon'ts" naturally can be used with `term.redirect`, but they also come with a `meta` value which contains all the information of the object, including cursor X and Y, width and height, the whole framebuffer, the cursor blinking, and more.
+
+Windon't windows behave very similarly to regular ol' Window API windows, with a few differences. For one, **Windon't windows support transparency when drawing over one another**.
+Secondly, **Windon'ts support the use of individual transformation functions for characters, text colors, background colors, and the whole meta function.** Transformation functions are, if given, called every time the window is rendered. More on that later.
+
+Additional values can be given to the newly created window through the `miscData` argument, including the base terminal and visibility.
+Here are all the values that you can set by default with `miscData`:
+```
+buffer			
+renderBuddies		-- table, a list of other windon't objects that will render beneath this one every time this redraws
+baseTerm		-- window, the terminal that this windon't object will render onto
+isColor
+
+charTransformation	-- function, ran on every X and Y on the window's base temrinal, I'll explain in a bit
+textTransformation	-- function, in a bit
+backTransformation	-- function, in a bit
+metaTransformation	-- function, takes in the 'meta' value of a windon't object so it can be modified
+
+cursorX			-- number, starting cursor X
+cursorY			-- number, starting cursor Y
+
+textColor		-- string, starting text color ("0" through "f", or "-"" for transparency)
+backColor		-- string, starting background color (same range as textColor)
+
+blink			-- boolean, cursor blinking
+alwaysRender		-- boolean, if true, then all term.write or term.blit calls will immediately render to the base temrinal
+visible			-- boolean, if false, then the window just like, won't render, man
+```
+
+All transformation functions (except for `metaTransformation`) are called on every (x, y) position on the screen per window, and each one takes in three arguments:
+	1. X position on the screen relative to the window's X position
+	2. Y position on the screen relative to the window's Y position
+	3. `meta` value of the window
+and return the following information:
+	1. New X position for that part of the window
+	2. New Y position for that part of the window
+	3. Optionally, a new character, text color, or background color (depending on if it's `charTransformation`, `textTransformation`, or `backTransformation`.)
+
+`metaTransformation` is different in that it takes one value, being the window's `meta` value, and returns nothing. The `metaTransformation` function just modifies the `meta` value and that's it.
+As a side note, the order that the transformations are called in is as follows:
+	1. metaTransformation
+	2. charTransformation
+	3. textTransformation
+	4. backTransformation
+
+<<< MORE ON THAT LATER >>>
+
+## windont.render
+```
+windont.render(optional number x1, optional number x2, optional number y, winodw_1, window_2, ...)
+```
+Renders one or more Windon't objects onto their base terminals. If two or more windows share a base terminal, they will render layered atop each other from top to bottom, meaning that `window_1` will draw on top of `window_2`.
+If windows contain any transparent regions (designated by the color "-" usable with `term.blit`), then the next window down the list will peek through.
+Transparency is applied individually for text colors and background colors. If you have a window with a solid BG color but a transparent text color, then the background color of the underlying window will now be the text color of the above window, kinda like a text-shaped stencil.
+
+The optional values `x1`, `x2`, and `y` are used if you want to render to only render onto a specific line on the base terminal (specifically, line `y` from X `x1` to `x2`).
+If a window's meta has `alwaysRender = true`, then `windont.render` is called with that window, as well as the positions of the write/blit call.