mirror of https://github.com/zcash/zcash_spec.git
Add crate-level documentation
This commit is contained in:
parent
94aab28ce1
commit
ea227f86c6
10
src/lib.rs
10
src/lib.rs
|
@ -1,3 +1,13 @@
|
||||||
|
//! This crate provides low-level types for implementing Zcash specifications. When a
|
||||||
|
//! common function defined in [the Zcash Protocol Specification] is used in multiple
|
||||||
|
//! protocols (for example the Sapling and Orchard shielded protocols), a corresponding
|
||||||
|
//! common type in this crate can be shared between implementations (for example by the
|
||||||
|
//! [`sapling-crypto`] and [`orchard`] crates).
|
||||||
|
//!
|
||||||
|
//! [the Zcash Protocol Specification]: https://zips.z.cash/protocol/protocol.pdf
|
||||||
|
//! [`sapling-crypto`]: https://crates.io/crates/sapling-crypto
|
||||||
|
//! [`orchard`]: https://crates.io/crates/orchard
|
||||||
|
|
||||||
#![deny(rustdoc::broken_intra_doc_links)]
|
#![deny(rustdoc::broken_intra_doc_links)]
|
||||||
|
|
||||||
mod prf_expand;
|
mod prf_expand;
|
||||||
|
|
Loading…
Reference in New Issue