Skip to content

Commit

Permalink
Consolidate VM documentation (lambdaclass#1866)
Browse files Browse the repository at this point in the history
* Add tooling section

* Link to new section with doc

* Copy documentation

* Remove unused section

* Fix typo

* Clean up doc

* Add instruction format section

* Add more todos

* Add description to some tools

* Ack doc source

* Add hint and builtin documentation

* Remove extra todo

* Fix grammar error

* Update prover link

* Mention Code Walkthrough

* Remove TODO

* Add example
  • Loading branch information
JulianGCalderon authored Jan 6, 2025
1 parent 87c10b3 commit 259487e
Show file tree
Hide file tree
Showing 2 changed files with 371 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# Documentation

* [How does the Cairo VM work?](./vm/)
* [How does the original Cairo VM work?](./python_vm/)
* [Benchmarks](./benchmarks/)
* [Custom Hint Processor](./hint_processor/)
* [How to run a cairo program with custom hints](./hint_processor/builtin_hint_processor)
* [References parsing](./references_parsing/)
* [Tracer](./tracer/)
* [Debugging](./debugging.md)

## Tooling

* [cairo1-run](/cairo1-run): Execute Cairo 1 programs
* [cairo-vm-cli](/cairo-vm-cli): Execute Cairo 0 programs
* [cairo-vm-tracer](/cairo-vm-tracer)
* [fuzzer](/fuzzer)
* [hint_accountant](/hint_accountant)
Loading

0 comments on commit 259487e

Please sign in to comment.