Add a link to the workspace README to help with packaging

entropyxyz · Nov 19, 2024 · 98583e0 · 98583e0
1 parent d82678b
commit 98583e0
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/manul/Cargo.toml b/manul/Cargo.toml
@@ -7,7 +7,7 @@ authors = ['Entropy Cryptography <[email protected]>']
 license = "AGPL-3.0-or-later"
 description = "Generic library for round-based protocols"
 repository = "https://github.com/entropyxyz/manul"
-readme = "../README.md"
+readme = "README.md"
 categories = ["cryptography", "no-std"]
 
 [dependencies]

diff --git a/manul/README.md b/manul/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/manul/src/lib.rs b/manul/src/lib.rs
@@ -1,6 +1,6 @@
 #![no_std]
 #![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
-#![doc = include_str!("../../README.md")]
+#![doc = include_str!("../README.md")]
 #![warn(
     clippy::mod_module_files,
     missing_docs,