From 49cba3935a0876743d0ecc9fc14b4085322a4c90 Mon Sep 17 00:00:00 2001
From: trivernis <trivernis@protonmail.com>
Date: Sun, 21 Jul 2024 18:43:00 +0200
Subject: [PATCH] Add README

---
 README.md | 98 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6b1892b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,98 @@
+# Snek Lang Parser
+
+This is a parser implementation for snek-lang using [pest](https://pest.rs).
+
+Snek-Lang is a programming language that I'm working on and might never finish.
+I don't know where this will lead me.
+
+## Snek-Lang (so far)
+
+### Primitives
+
+```sk
+100            // Int
+1.0, .1        // Float
+true, false    // Bool
+0xFF, 0b100    // Byte
+"Hello World"  // Str
+```
+
+### Expressions
+
+Every expression has to evaluate to a value
+
+```sk
+// infix addition
+1 + 1                
+
+// function calls
+add2 4               
+
+// nested expressions
+1 * ( 1 - 1 )        
+
+// nested function calls
+add2 (sub4 (mul2 4)) 
+```
+
+### Declarations
+
+A declaration declares a variable. When listing arguments in that
+declaration those arguments have to be provided when accessing the variable (see function call above).
+Declarations without variables are only evaluated once (Probably but I have to think about that).
+
+```sk
+// simple declaration
+let a = 5
+
+// add arguments (converting it into a function)
+let add2 n = n + 2
+
+// nested statements with blocks
+let complex_addition a b c = {
+  let d = a + b
+  let e = b + c
+  d + e + 1
+}
+```
+
+### Complex types
+
+All type declarations follow a similar patter.
+The value for a type is one of the following:
+
+- `#[...]` enum
+- `#{...}` record
+- `#(...)` tuple
+
+These expressions can be nested.
+
+```sk
+type MyEnum = #[
+  Var1 Int
+  Var2 Bool
+]
+
+type MyRec = #{
+  field1: Float
+  field2: Str
+}
+
+// records declared in one line need to put a semicolon after each field declaration
+type MyRecOneline = #{field1: Float; field2: Str}
+
+// tuples can be declared in one line without a semicolon because there's no ambiguity 
+type MyTuple = #(Float Str)
+
+type Nested = #{
+  field1: #[
+    Boolean Bool
+    Number Float
+  ]
+  field2: #(Bool Bool)
+  field3: #{
+    first: Int
+    second: Int
+  }
+}
+```