From ac3bf7d594a515dcd238c8e369960b89720f26c1 Mon Sep 17 00:00:00 2001
From: Nat Lasseter <nat.lasseter@exa.net.uk>
Date: Tue, 16 Jul 2019 11:14:38 +0100
Subject: Initial commit

---
 README.textile | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.textile

(limited to 'README.textile')

diff --git a/README.textile b/README.textile
new file mode 100644
index 0000000..28ca3e3
--- /dev/null
+++ b/README.textile
@@ -0,0 +1,31 @@
+h1. Rubiks
+
+A Rubiks cube library (rubiks/cube) and TUI (rubiks) written in Go.
+
+h2. Why?
+
+Because. Bored.
+
+h2. Coordinates
+
+Okay, this bit is weird because I was hacking it as I went. (0,0,0) is the right front top cubelet.
+
+- X-axis := Right to left
+- Y-axis := Front to back
+- Z-axis := Top to bottom
+
+h2. Display
+
+@func (cube) String() string@ displays the cube in the form:
+
+pre..     UUU
+     UUU
+     UUU
+LLL  FFF  RRR  BBB
+LLL  FFF  RRR  BBB
+LLL  FFF  RRR  BBB
+     DDD
+     DDD
+     DDD
+
+p. Note that this is the net of the cube, and so the rear face is mirrored right-to-left, as it has been unfolded around from the back.
-- 
cgit v1.2.3

