From a4a777ba7ef34a22e63a9df93d0eca143967103a Mon Sep 17 00:00:00 2001
From: William Bell <epicugric@gmail.com>
Date: Tue, 22 Nov 2022 16:02:03 +0000
Subject: [PATCH] update spec

---
 .DS_Store | Bin 0 -> 6148 bytes
 spec.md   | 113 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 113 insertions(+)
 create mode 100644 .DS_Store
 create mode 100644 spec.md

diff --git a/.DS_Store b/.DS_Store
new file mode 100644
index 0000000000000000000000000000000000000000..220c1c2cdfc67b69cd7b97f6d1a94f5743e0a976
GIT binary patch
literal 6148
zcmeHKF=_)r43uIQhBPiy?iccd#W*kU2SRK}bNIj}sjter@-)v#Dq;>-CXE?^cJ{Oy
zEjPvKWM;nkI=q^#&1?lH+7Fkx@ti)hr-~4rHTJ{DI1bp_VwQX(K<>iMcC!89{Ffi0
z@7?J*jK@zTv8qf8NC7Dz1*Cu!xLbj0sjKI^E2)4KkOGgU0KX3nPV9wKVthKV#0UUf
zA{>T&%o4!H0I(NMiHN{FslcRqjToME#9QU{!YMK7=5aIX)XiQKipTAUw@5ediCU$A
z6u4HPhV(W2{~P?q{C`c-lN68w52b)Fx4Z2IuT;Ht_HyjC4gL;i&M%yXeNeDOI|fEO
h#sk~&OC)7p;~wX|a7qk1;z0-MXMnoMq`-eGZ~@d}7g7KK

literal 0
HcmV?d00001

diff --git a/spec.md b/spec.md
new file mode 100644
index 0000000..689bf45
--- /dev/null
+++ b/spec.md
@@ -0,0 +1,113 @@
+# ARGON 3 beta 1.0
+
+This is the specification on how to create an Argon interpreter.
+
+This specification should be used as a guildline, and is subject to change for later versions.
+
+Later updates for Argon 3 should be backwards compatable (where possible) with code designed for older versions
+of the interpreter.
+
+The Argon 3 interpreter is not intentionally designed to understand code written for Argon 1 and/or 2, but may
+follow some design patterns found in those interpreters.
+
+Argon 3 is a programming language primarily designed for maths computation, it is designed to use techniques and
+rules set in maths. It's designed to be easy for mathematicians to write and understand algorithms in.
+(e.g. `f(x) = x^2` to set a function)
+
+reused variables, and infomation for use in understanding the pseudo REGEX:
+
+-   NAME = [a-zA-Z][a-za-z0-9]\*
+-   spaces used in the pseudo REGEX should be taken as 1 or many spaces.
+-   there can be 0 or more spaces around any of the pseudo REGEX
+
+---
+
+## set variable
+
+`(let/const or nothing) {NAME} = {ANY}`
+
+let and const variables will set variables. if a const is already set in that stack, it will throw an error.
+at the end of a opperation (e.g. if, while, or function) drop the variable stack.
+
+having no verb at the start suggests the program would like to edit a variables from a different stack.
+if there is no variable found in the other stacks, then it sets one in the current stack as a let.
+
+setting variables returns the value, which can be used.
+
+example:
+
+```
+if (x = 10) > 5 [
+    log(x, 'is bigger than 5')
+]
+```
+
+---
+
+## functions
+
+`(let/const or nothing) {NAME}({PARAMS}) = {CODE}`
+
+the starting verb follows the rules set by [set variable](#set-variable).
+
+function can be called by using its name followed by brackets with the params.
+
+example:
+
+```
+
+const f(x) = x^2 + 2*x + 1
+log('f(10) =', f(10))
+
+```
+
+output:
+
+```
+
+f(10) = 121
+
+```
+
+if the function does not return, then the value given is unknown/null
+
+---
+
+## wrap
+
+`[{CODE}]`
+
+a wrap encloses code in square brackets. its used to create a new scope, so variables set from
+inside the wraps scope are deleted once the wrap is finished.
+
+example:
+
+```
+let name = unknown
+[
+    name = input('name: ')
+    let age = input('age: ')
+    log('you are', age, 'years old!')
+]
+log('hello', name)
+log('we do not know your age anymore because it got deleted when the wrap finished.')
+```
+
+A wrap, unless specificifed otherwise, can have a return value. This value can be used as the value of the wrap.
+
+example:
+
+```
+const password = [
+    let password = input("set password: ")
+    while len(password) < 8 [
+        log("password must be longer then 8 characters!")
+        password = input("set password: ")
+    ]
+    return password
+]
+
+log("your password is", password)
+```
+
+If the wrap does not take a return value, then the wrap passes the return value back to a parent wrap.