Started docs

auralangco · May 27, 2024 · e0fca00 · e0fca00
1 parent 0e770a5
commit e0fca00
Show file tree

Hide file tree

Showing 7 changed files with 31 additions and 0 deletions.
diff --git a/docs/aura.md b/docs/aura.md
@@ -0,0 +1,8 @@
+# Aura Docs
+
+- [Data](./data.md)
+- [Call](./call.md)
+- [Control Flow](./flow.md)
+- [Types](./type.md)
+- [Tags](./tags.md)
+- [Targets](./targets.md)
diff --git a/docs/call.md b/docs/call.md
diff --git a/docs/data.md b/docs/data.md
@@ -0,0 +1,23 @@
+# Aura: Data
+
+The way Aura treats data and memory depends on the target, but doesn't affect the result of the computation.
+
+## AuraVM
+
+WIP
+
+## C
+
+When targeting C there are three possibilities:
+
+- Data is used only once, so it's moved
+- Data is shared by reference when passed as arguments to calls
+- Data is copied when passed as argument to data constructors
+
+## JS
+
+WIP
+
+## Immutability
+
+The important thing to notice is: data is always immutable. So everytime you pass data to somewhere else, the original data is preserved
diff --git a/docs/flow.md b/docs/flow.md
diff --git a/docs/tags.md b/docs/tags.md
diff --git a/docs/targets.md b/docs/targets.md
diff --git a/docs/type.md b/docs/type.md