From 4c97b7c25683d8bccc282fe0b273d7758b108b92 Mon Sep 17 00:00:00 2001
From: D V <77478658+DarhkVoyd@users.noreply.github.com>
Date: Tue, 24 Oct 2023 23:16:31 +0530
Subject: [PATCH] fix: cargo publish warning about README (#960)

**Description**
- When running `cargo publish -p martin`, the following warning was
displayed.
```shell
readme `../README.md` appears to be a path outside of the package, but there is already a file named `README.md` in the root of the package. The archived crate will contain the copy in the root of the package. Update the readme to point to the path relative to the root of the package to remove this warning.
```
- Till the time of this PR, the issue was probably a bug with Cargo, in
case of a project with a symlink readme linking to the workspace readme.

**Changes Made**
- To avoid the warning until the issue is fixed with Cargo, the solution
is by manually setting `readme = "README.md"` instead of
`readme.workspace = true`.

**Testing**
- [x] I have tried running `cargo publish -p martin` for a few seconds,
and hit `Ctrl+C` the moment it starts compiling. The above readme
warning is no longer shown.

Closes: #914
---
 martin/Cargo.toml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/martin/Cargo.toml b/martin/Cargo.toml
index 800b24139..41dce6fcd 100644
--- a/martin/Cargo.toml
+++ b/martin/Cargo.toml
@@ -14,7 +14,7 @@ edition.workspace = true
 license.workspace = true
 repository.workspace = true
 rust-version.workspace = true
-readme.workspace = true
+readme = "README.md"
 homepage.workspace = true
 
 [package.metadata.deb]