doc: readme

caelansar · May 17, 2024 · e0e0a05 · e0e0a05
1 parent f894b2e
commit e0e0a05
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/Makefile b/Makefile
@@ -6,6 +6,12 @@ build:
 build_eval:
 	cargo build --release --bin caescript --features=build-binary
 
+install:
+	cargo install --features=build-binary,vm --path .
+
+install_eval:
+	cargo install --features=build-binary --path .
+
 .PHONY: test
 test:
 	cargo test --all-features
diff --git a/README.md b/README.md
@@ -19,20 +19,20 @@ reading through [Writing An Interpreter In Go](https://interpreterbook.com/) and
 ### Build from source code
 - Build release
 ```
-$ cargo build --release --bin caescript
+$ make install_eval
 ```
 - Build release using the Compiler implementation
 ```
-$ cargo build --release --features=vm  --bin caescript
+$ make install
 ```
 - Running the REPL
 ```bash
-$ ./caescript
+$ caescript
 ```
 
 - Running the Interpreter/Compiler
 ```bash
-$ ./caescript [vm/eval] examples/hello.cae
+$ caescript [vm/eval] examples/hello.cae
 ```
 
 ### With online playground