Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate VM documentation #1866

Merged
merged 18 commits into from
Jan 6, 2025
Merged

Consolidate VM documentation #1866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
e97d5bb
Add tooling section
JulianGCalderon Nov 4, 2024
ea0d004
Link to new section with doc
JulianGCalderon Nov 4, 2024
3bee81c
Copy documentation
JulianGCalderon Nov 4, 2024
d2ded9b
Remove unused section
JulianGCalderon Nov 4, 2024
ecb9568
Fix typo
JulianGCalderon Nov 4, 2024
ab05b23
Clean up doc
JulianGCalderon Nov 4, 2024
6365484
Add instruction format section
JulianGCalderon Nov 4, 2024
0f94a3e
Add more todos
JulianGCalderon Nov 4, 2024
74c3e5c
Add description to some tools
JulianGCalderon Nov 4, 2024
5d08f7d
Ack doc source
JulianGCalderon Nov 4, 2024
5acfa5e
Add hint and builtin documentation
JulianGCalderon Nov 4, 2024
25ceaa7
Remove extra todo
JulianGCalderon Nov 4, 2024
506698c
Fix grammar error
JulianGCalderon Nov 4, 2024
7a44362
Update prover link
JulianGCalderon Nov 4, 2024
b30f723
Merge branch 'main' into docs
JulianGCalderon Dec 19, 2024
ab60b1a
Mention Code Walkthrough
JulianGCalderon Dec 19, 2024
fddba57
Remove TODO
JulianGCalderon Dec 19, 2024
f112a3e
Add example
JulianGCalderon Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/README.md
View file
Open in desktop
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
Loading