Update readme with evn command (#1460)

* Update readme with evn command * Edit readme --------- Co-authored-by: Leandro Ferrigno <[email protected]>
lambdaclass · Oct 11, 2023 · a47c0c8 · a47c0c8
1 parent 30eb46d
commit a47c0c8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -18,6 +18,7 @@ cairo-vm-pypy-env/*
 /cairo2/
 /cairo-lang/
 *.tar
+cairo-vm-cli/air_input.pub
 
 ensure-no_std/Cargo.lock
 

diff --git a/README.md b/README.md
@@ -86,6 +86,18 @@ These dependencies are only necessary in order to run the original VM, compile C
 
 You can install all of the required and optional dependencies by running the script `install.sh` while in the repository root.
 
+### Installing project dependencies
+
+In order to compile programs you need to install the cairo-lang package.
+
+Running the  `make deps` (or the `make deps-macos`  if you are runnning in MacOS) command will create a virtual environment with all the required dependencies.
+
+You can then activate this enviroment by running
+ ```bash
+. cairo-vm-env/bin/activate
+```
+
+
 ## 🚀 Usage
 
 ### Adding cairo-vm as a dependency
@@ -110,6 +122,11 @@ The `-F lambdaworks-felt` part adds usage of [`lambdaworks-math`](https://github
 
 Once the binary is built, it can be found in `target/release/` under the name `cairo-vm-cli`.
 
+In order to compile Cairo programs you need to activate the environment created while installing dependencies. To start it, run:
+```bash
+. cairo-vm-env/bin/activate
+```
+
 To compile a program, use `cairo-compile [path_to_the_.cairo_file] --output [desired_path_of_the_compiled_.json_file]`. For example:
 
 ```bash
@@ -133,6 +150,8 @@ cd cairo-vm
 
 cargo build --release
 
+. cairo-vm-env/bin/activate
+
 cairo-compile cairo_programs/abs_value_array.cairo --output cairo_programs/abs_value_array_compiled.json
 
 target/release/cairo-vm-cli cairo_programs/abs_value_array_compiled.json --layout all_cairo