Skip to content

Commit

Permalink
docs: Describe purpose of individual crates
Browse files Browse the repository at this point in the history
changelog: ignore
  • Loading branch information
jan-ferdinand committed Sep 10, 2024
1 parent 07fdf15 commit 7926a12
Show file tree
Hide file tree
Showing 8 changed files with 21 additions and 4 deletions.
2 changes: 1 addition & 1 deletion triton-air/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ description = """
The Arithmetic Intermediate Representation (AIR) for Triton VM.
"""

readme = "README.md"
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
homepage.workspace = true
documentation.workspace = true
repository.workspace = true
readme.workspace = true

[dependencies]
arbitrary.workspace = true
Expand Down
4 changes: 4 additions & 0 deletions triton-air/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Triton VM AIR

This crate is part of the [Triton VM](https://triton-vm.org) ecosystem. It contains the definition
of the AIR constraints, which are part of the STARK proving system.
2 changes: 1 addition & 1 deletion triton-constraint-builder/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ description = """
Emits efficient code from Triton VM's AIR.
"""

readme = "README.md"
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
homepage.workspace = true
documentation.workspace = true
repository.workspace = true
readme.workspace = true

[dependencies]
air.workspace = true
Expand Down
5 changes: 5 additions & 0 deletions triton-constraint-builder/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Constraint Circuit Builder

This crate is part of the [Triton VM](https://triton-vm.org) ecosystem. It contains the code
generator emitting efficient Rust code for Triton VM's AIR constraints, which are part of the STARK
proving system.
2 changes: 1 addition & 1 deletion triton-constraint-circuit/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ description = """
AIR constraints build helper for Triton VM.
"""

readme = "README.md"
version.workspace = true
edition.workspace = true
authors.workspace = true
license.workspace = true
homepage.workspace = true
documentation.workspace = true
repository.workspace = true
readme.workspace = true

[dependencies]
arbitrary.workspace = true
Expand Down
4 changes: 4 additions & 0 deletions triton-constraint-circuit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Constraint Circuit

This crate is part of the [Triton VM](https://triton-vm.org) ecosystem. It contains logic that helps
building efficient AIR constraints, which are part of the STARK proving system.
2 changes: 1 addition & 1 deletion triton-isa/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ name = "triton-isa"
description = """
The instruction set architecture for Triton VM.
"""
readme = "README.md"

version.workspace = true
edition.workspace = true
Expand All @@ -11,7 +12,6 @@ license.workspace = true
homepage.workspace = true
documentation.workspace = true
repository.workspace = true
readme.workspace = true

[dependencies]
arbitrary.workspace = true
Expand Down
4 changes: 4 additions & 0 deletions triton-isa/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Triton VM's Instruction Set Architecture

This crate is part of the [Triton VM](https://triton-vm.org) ecosystem. It contains the basic
definitions for Triton VM's instructions as well as program parsing functionality.

0 comments on commit 7926a12

Please sign in to comment.