From a626b5a0e4a219c4b70c738db2600c3e139a1520 Mon Sep 17 00:00:00 2001 From: andrea Date: Mon, 28 Oct 2024 10:40:34 -0700 Subject: [PATCH] Replace the `ironfish-primitives` and `ironfish-proofs` READMEs with the workspace README --- ironfish-primitives/README.md | 32 +------------------------------- ironfish-primitives/src/lib.rs | 2 +- ironfish-proofs/README.md | 33 +-------------------------------- ironfish-proofs/src/lib.rs | 2 +- 4 files changed, 4 insertions(+), 65 deletions(-) mode change 100644 => 120000 ironfish-primitives/README.md mode change 100644 => 120000 ironfish-proofs/README.md diff --git a/ironfish-primitives/README.md b/ironfish-primitives/README.md deleted file mode 100644 index efa356ba3e..0000000000 --- a/ironfish-primitives/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# zcash_primitives - -This library contains Rust implementations of the Zcash primitives. - -## License - -Licensed under either of - - * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) - * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. - -Downstream code forks should note that 'zcash_primitives' depends on the -'orchard' crate, which is licensed under the -[Bootstrap Open Source License](https://github.com/zcash/orchard/blob/main/LICENSE-BOSL). -A license exception is provided allowing some derived works that are linked or -combined with the 'orchard' crate to be copied or distributed under the original -licenses (in this case MIT / Apache 2.0), provided that the included portions of -the 'orchard' code remain subject to BOSL. -See https://github.com/zcash/orchard/blob/main/COPYING for details of which -derived works can make use of this exception. - -### Contribution - -Unless you explicitly state otherwise, any contribution intentionally -submitted for inclusion in the work by you, as defined in the Apache-2.0 -license, shall be dual licensed as above, without any additional terms or -conditions. - diff --git a/ironfish-primitives/README.md b/ironfish-primitives/README.md new file mode 120000 index 0000000000..32d46ee883 --- /dev/null +++ b/ironfish-primitives/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/ironfish-primitives/src/lib.rs b/ironfish-primitives/src/lib.rs index f1023e67a0..0cf33d814e 100644 --- a/ironfish-primitives/src/lib.rs +++ b/ironfish-primitives/src/lib.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #![cfg_attr(docsrs, feature(doc_cfg))] // Temporary until we have addressed all Result cases. diff --git a/ironfish-proofs/README.md b/ironfish-proofs/README.md deleted file mode 100644 index ccbdcfd73f..0000000000 --- a/ironfish-proofs/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# zcash_proofs - -This library contains the zk-SNARK circuits for Zcash, and the APIs for creating -and verifying proofs. - -## License - -Licensed under either of - - * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or - http://www.apache.org/licenses/LICENSE-2.0) - * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) - -at your option. - -Downstream code forks should note that 'zcash_proofs' depends on the -'orchard' crate, which is licensed under the -[Bootstrap Open Source License](https://github.com/zcash/orchard/blob/main/LICENSE-BOSL). -A license exception is provided allowing some derived works that are linked or -combined with the 'orchard' crate to be copied or distributed under the original -licenses (in this case MIT / Apache 2.0), provided that the included portions of -the 'orchard' code remain subject to BOSL. -See https://github.com/zcash/orchard/blob/main/COPYING for details of which -derived works can make use of this exception. - -### Contribution - -Unless you explicitly state otherwise, any contribution intentionally -submitted for inclusion in the work by you, as defined in the Apache-2.0 -license, shall be dual licensed as above, without any additional terms or -conditions. - diff --git a/ironfish-proofs/README.md b/ironfish-proofs/README.md new file mode 120000 index 0000000000..32d46ee883 --- /dev/null +++ b/ironfish-proofs/README.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/ironfish-proofs/src/lib.rs b/ironfish-proofs/src/lib.rs index 3f7d3a63a2..9f2a54b4d4 100644 --- a/ironfish-proofs/src/lib.rs +++ b/ironfish-proofs/src/lib.rs @@ -1,4 +1,4 @@ -#![doc = include_str!("../../README.md")] +#![doc = include_str!("../README.md")] #![cfg_attr(docsrs, feature(doc_cfg))] // Temporary until we have addressed all Result cases.