Skip to content

Commit

Permalink
Minor changes to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rodrigo-pino committed Aug 23, 2023
1 parent 35fa852 commit a612fac
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This Virtual Machine is still in development and there is no public release avai
Currently, it is only possible to use it by building it from source by following these instructions:

1. Clone the repo to your machine: `git clone https://github.com/NethermindEth/cairo-vm-go`.
2. Install `golang` on your PC, instructions [here](https://go.dev/.doc/install).
2. Install `Go` on your PC, instructions [here](https://go.dev/.doc/install).
3. Execute on the root folder of the repo: `make build`.
4. Make sure everything is running smoothly by executing: `make test`.

Expand All @@ -35,6 +35,8 @@ make help

## Documentation

We are planning on writing our documentation soon detailing how we adapt the theory of a non-deterministic machine to a deterministic one. Meanwhile, the next is a list of resources we are currently using to develop the VM.

### Cairo

* Cairo Zero Docs: [How Cairo Works](https://docs.cairo-lang.org/0.12.0/how_cairo_works/index.html)
Expand All @@ -43,7 +45,7 @@ make help

### Other

The previous list includes the most helpful documentation for the current state of the project but it does not represent all available documentation. If you are interested to go beyond, there is this [list](https://github.com/lambdaclass/cairo-vm#-documentation) made by [LambdaClass](https://github.com/lambdaclass) which has a much broader scope.
The previous list includes the most helpful documentation for the current state of the project but it does not represent all that is available. If you are interested in going beyond, there is this [list](https://github.com/lambdaclass/cairo-vm#-documentation) made by [LambdaClass](https://github.com/lambdaclass) which has a much broader scope.

## Related Projects

Expand Down

0 comments on commit a612fac

Please sign in to comment.