github: readme, license, travis

Dentrax · Dentrax · commit 4716d8a1d901 · 2020-06-20T16:31:19.000+03:00
Signed-off-by: Furkan &lt;furkan.turkal@hotmail.com&gt;
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,17 @@
+language: rust
+rust:
+  - 1.43.0
+  - stable
+  - nightly
+sudo: false
+env:
+  global:
+    - RUSTFLAGS="--deny warnings"
+    - RUST_BACKTRACE=1
+    - CARGO_INCREMENTAL=0
+script:
+  - cargo test --all
+  - cargo build
+notifications:
+  email:
+    on_success: never
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "tl"
+name = "Monkey"
 version = "0.1.0"
 authors = ["Furkan <furkan.turkal@hotmail.com>"]
 edition = "2018"
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Furkan Türkal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,136 @@
+# Monkey
+
+[![Build](https://travis-ci.org/Dentrax/Monkey.svg?branch=master)](https://travis-ci.org/Dentrax/Monkey)
+
+**Yet another Monkey interpreter implementation in Rust, based on Thorsten Ball's [Writing An Interpreter In Go](https://interpreterbook.com/) book.**
+
+## Features
+* AST
+* Tokenizer
+* Parser
+* Lexer
+* Evaluator
+* Builtin Functions
+* Read–Eval–Print Loop
+
+## Usage
+
+### Test
+
+```rust
+cargo test --all
+```
+
+### Run
+
+```rust
+cargo run
+```
+
+```bash
+Monkey Interpreter v0.1.0
+>>> "Hello, " + "World!"
+Hello, World!
+>>>
+```
+
+## Examples
+
+### Functions
+
+```rust
+[1, 2 * 2, 3 + 3]
+```
+
+
+### Function Call
+
+```rust
+let identity = fn(x) { x; }; identity(7); //7
+```
+
+```rust
+let add = fn(a, b) { a + b }; 
+let sub = fn(a, b) { a - b }; 
+let applyFunc = fn(a, b, func) { 
+    func(a, b) 
+}; 
+applyFunc(10, 2, sub); //8
+```
+
+### If
+
+
+```rust
+if (x < y) { z } else { w }
+```
+
+### Nested If
+
+```rust
+if (2 > 1) { if (3 > 1) { return 7; } return 0; }
+```
+
+### HashMap
+
+```rust
+{"one": 0 + 1, "two": 10 - 8, "ten": 50 / 5}
+```
+
+### Arrays
+
+```rust
+let arr = [1, 2 * 2, 3 + 3] //arr[1 + 1] => returns 6
+```
+
+### Operator Precedence
+
+```rust
+3 + 4 * 5 == 3 * 1 + 4 * 5 //((3 + (4 * 5)) == ((3 * 1) + (4 * 5)))
+```
+
+### Error Handlers
+
+```rust
+if (10 > 1) { if (10 > 1) { return true + false; } return 1; } //unknown operator: BOOLEAN + BOOLEAN
+```
+
+```rust
+let newAdder = fn(x) { fn(y) { x + y } }; let addTwo = newAdder(2); x //identifier not found: x
+```
+
+## Complete Example
+
+### Builtin
+
+```rust
+let map = fn(arr, f) {
+	let iter = fn(arr, accumulated) {
+		if (len(arr) == 0) {
+			accumulated
+		} else {
+			iter(rest(arr), push(accumulated, f(first(arr))));
+		}
+	};
+	iter(arr, []);
+};
+let a = [1, 2, 3, 4];
+let double = fn(x) { x * 2 };
+map(a, double);
+```
+
+### HashMap
+
+```rust
+let people = [{"name": "Alice", "age": 24}, {"name": "Anna", "age": 28}];
+let getAge = fn(person) { person["name"]; };
+return getAge(people[0]) + getAge(people[1]);
+```
+
+## TODO
+- [ ] Impl Compiler
+- [ ] Impl VM
+ 
+## License
+
+MIT License ([LICENSE](LICENSE)).
