Initial Commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..96da413
--- /dev/null
+++ b/README
@@ -0,0 +1,28 @@
+Simple bash script for drawing graphics in the terminal, takes as input drawing
+commands, and will print either the raw image or the braille version of the
+image as an output
+
+begin:
+	CANVAS or
+		X then
+		Y
+		#makes a XxY canvas filled with ".", which is the character
+		#interpreted as a blank when converting to braille
+	LOAD_RAW or
+		FOOBAR repeat until
+		END_RAW
+		#loads the lines FOOBAR into the image buffer
+	LOAD_POINT or
+		X then
+		Y then
+		C
+		#loads the character C into position X,Y
+	PRINT_RAW or
+		#prints the raw image buffer
+	PRINT_BRAILLE or
+		#prints the output in braille, this uses only the width of the
+		#first row so make sure to call CANVAS or something before hand
+	END
+		#ends the script
+
+examples are in INPUT and INPUT2