summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README34
1 files changed, 34 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7f6df40
--- /dev/null
+++ b/README
@@ -0,0 +1,34 @@
+Copyright 2021 Gabriel Jensen
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program.
+If not, see <https://www.gnu.org/licenses/>.
+
+IMPORTANT FORMATING INFORMATION ABOUT LITERALS:
+
+Integral literals in Luma are written in base-twelve.
+The number 10 would be written as ↊ (U+218A ↊ Turned Digit Two), and the number 11 would be written as ↋ (U+218B ↋ Turned Digit Three).
+Also, integral literals are also written as little-endian, so numbers increment to the right instead of the left.
+Down below is a short conversion table for how integral literals must be written:
+ 8 -> 8
+ 9 -> 9
+ 10 -> ↊
+ 11 -> ↋
+ 12 -> 01
+ 13 -> 11
+ 14 -> 21
+ 15 -> 31
+ 16 -> 41
+ 100 -> 48
+ 120 -> 0↊
+ 132 -> 0↋
+ 144 -> 001
+ 156 -> 011
+ 168 -> 021
+1000 -> 4↋6
+1728 -> 0001
+Also remember that integral literals must start with '#' (U+0023 # NUMBER SIGN).