chore: add licenses and update descriptions in license (#1090)

* chore: update license and description of crates

* chore: add rv32-adapters to layout

Cargo.toml

@@ -2,9 +2,10 @@
 version = "0.1.0-alpha"
 edition = "2021"
 rust-version = "1.82"
-authors = ["Intrinsic Technologies"]
+authors = ["OpenVM Authors"]
 homepage = "https://openvm.dev"
 repository = "https://github.com/openvm-org/"
+license = "MIT"
 
 [workspace]
 members = [

benchmarks/Cargo.toml

@@ -5,6 +5,7 @@ authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-build.workspace = true

crates/circuits/mod-builder/Cargo.toml

@@ -1,8 +1,12 @@
 [package]
 name = "openvm-mod-circuit-builder"
-version = "0.1.0"
-edition = "2021"
 description = "Modular arithmetic framework for building OpenVM circuits."
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-stark-backend = { workspace = true }

crates/circuits/poseidon2-air/Cargo.toml

@@ -3,6 +3,9 @@ name = "openvm-poseidon2-air"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [dependencies]
 p3-monty-31 = { workspace = true }

crates/circuits/primitives/Cargo.toml

@@ -1,9 +1,12 @@
 [package]
 name = "openvm-circuit-primitives"
+description = "Library of plonky3 primitives for general purpose use in other ZK circuits."
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "Library of plonky3 primitives for general purpose use in other ZK circuits."
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-stark-backend = { workspace = true }

crates/circuits/primitives/derive/Cargo.toml

@@ -1,8 +1,12 @@
 [package]
 name = "openvm-circuit-primitives-derive"
+description = "Procedural macros for writing circuits as AIRs."
 version.workspace = true
+authors.workspace = true
 edition.workspace = true
-description = "Procedural macros for writing circuits as AIRs."
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [lib]
 proc-macro = true

crates/cli/Cargo.toml

@@ -3,7 +3,11 @@ name = "cargo-openvm"
 description = "OpenVM CLI tools"
 readme = "README.md"
 version.workspace = true
+authors.workspace = true
 edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [build-dependencies]
 vergen = { version = "8", default-features = false, features = [

crates/sdk/Cargo.toml

@@ -5,6 +5,7 @@ authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-algebra-circuit = { workspace = true }

crates/toolchain/build/Cargo.toml

@@ -1,11 +1,12 @@
 [package]
 name = "openvm-build"
+description = "OpenVM build tools"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
-description = "OpenVM build tools"
+license.workspace = true
 
 [dependencies]
 openvm-platform = { workspace = true }

crates/toolchain/instructions/Cargo.toml

@@ -5,6 +5,7 @@ authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-stark-backend.workspace = true

crates/toolchain/instructions/derive/Cargo.toml

@@ -5,6 +5,7 @@ authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
+license.workspace = true
 
 [lib]
 proc-macro = true

crates/toolchain/macros/Cargo.toml

@@ -1,9 +1,8 @@
 [package]
 name = "openvm-macros-common"
 version.workspace = true
-edition.workspace = true
-rust-version.workspace = true
 authors.workspace = true
+edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
 

crates/toolchain/openvm/Cargo.toml

@@ -1,11 +1,12 @@
 [package]
 name = "openvm"
 description = "OpenVM standard Rust library for guest programs."
-version = { workspace = true }
-edition = { workspace = true }
-# license = { workspace = true }
-homepage = { workspace = true }
-repository = { workspace = true }
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
 
 [dependencies]
 openvm-platform = { workspace = true, features = [

crates/toolchain/platform/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "openvm-platform"
 description = "OpenVM Rust platform definitions."
-version = { workspace = true }
-edition = { workspace = true }
-# license = { workspace = true }
-homepage = { workspace = true }
-repository = { workspace = true }
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 stability = "0.2"

crates/toolchain/tests/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "openvm-toolchain-tests"
+description = "Tests for the OpenVM toolchain starting from Rust"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
 homepage.workspace = true
 repository.workspace = true
-description = "Tests for the OpenVM toolchain starting from Rust"
 
 [dependencies]
 openvm-circuit-primitives-derive.workspace = true

crates/vm/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-circuit"
+description = "OpenVM circuits"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "OpenVM circuits"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 p3-symmetric = { workspace = true }

crates/vm/derive/Cargo.toml

@@ -4,6 +4,7 @@ version.workspace = true
 edition.workspace = true
 authors.workspace = true
 description = "Procedural macros for OpenVM circuits."
+license.workspace = true
 
 [lib]
 proc-macro = true

docs/repo/layout.md

@@ -72,6 +72,7 @@ The toolchain, ISA, and VM are simultaenously extendable. All non-system functio
 - [`openvm-rv32im-circuit`](../../extensions/rv32im/circuit): Circuit extension for RV32IM instructions and IO instructions.
 - [`openvm-rv32im-transpiler`](../../extensions/rv32im/transpiler): Transpiler extension for RV32IM instructions and IO instructions.
 - [`openvm-rv32im-guest`](../../extensions/rv32im/guest): Guest library for RV32IM instructions and IO instructions. This is re-exported by the `openvm` crate for convenience.
+- [`openvm-rv32-adapters`](../../extensions/rv32-adapters): Circuit adapters for other circuit extensions to use to be compatible with the RISC-V 32-bit architecture.
 
 #### Native Recursion
 

extensions/algebra/circuit/Cargo.toml

@@ -1,8 +1,11 @@
 [package]
 name = "openvm-algebra-circuit"
-version = "0.1.0"
-edition = "2021"
-description = "Modular arithmetic circuits."
+description = "OpenVM circuit extension for algebra (modular arithmetic)"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm-circuit-primitives = { workspace = true }

extensions/algebra/guest/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-algebra-guest"
+description = "OpenVM guest library for algebra over rings and fields, including modular and complex field arithmetic."
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "OpenVM guest library for algebra over rings and fields, including modular and Fp2 arithmetic."
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm = { workspace = true }

extensions/algebra/transpiler/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-algebra-transpiler"
+description = "OpenVM transpiler extension for algebra (modular arithmetic)"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "Transpiler extension for modular arithmetic"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm-stark-backend = { workspace = true }

extensions/bigint/circuit/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-bigint-circuit"
+description = "OpenVM circuit extension for uint256 and int256"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "OpenVM circuit extension for uint256 and int256"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm-stark-backend = { workspace = true }

extensions/bigint/guest/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-bigint-guest"
+description = "OpenVM guest library for bigint"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "Guest extension for Int256"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm = { workspace = true }

extensions/bigint/transpiler/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-bigint-transpiler"
+description = "OpenVM transpiler extension for bigint"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "Transpiler extension for bigint"
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm-stark-backend = { workspace = true }

extensions/ecc/circuit/Cargo.toml

@@ -1,8 +1,11 @@
 [package]
 name = "openvm-ecc-circuit"
-version = "0.1.0"
-edition = "2021"
-description = "Elliptic curve circuits."
+description = "OpenVM circuit extension for elliptic curve cryptography"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm-circuit-primitives-derive = { workspace = true }

extensions/ecc/guest/Cargo.toml

@@ -1,9 +1,11 @@
 [package]
 name = "openvm-ecc-guest"
+description = "OpenVM guest library for elliptic curve cryptography"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true
-description = "OpenVM guest elliptic curve cryptography library."
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 openvm = { workspace = true }

extensions/ecc/sw-setup/Cargo.toml

@@ -1,7 +1,10 @@
 [package]
 name = "openvm-ecc-sw-setup"
-version = { workspace = true }
-edition = "2021"
+version.workspace = true
+authors.workspace = true
+edition.workspace = true
+homepage.workspace = true
+repository.workspace = true
 
 [dependencies]
 syn = { version = "2.0", features = ["full"] }