docs(ironrdp): README.md dedicated to the meta crate (#582)

Using the top-level README.md of the repository is not ideal.

1/ It contains many information unrelated to the meta crate itself.

2/ The following attribute:

```
 #![doc = include_str!("../../../README.md")]
```

will fail at finding the README.md when built via `cargo package`.
This commit is contained in:
Benoît Cortier 2024-11-20 20:15:29 +09:00 committed by GitHub
parent 36da11c02e
commit bab049aa00
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 10 additions and 4 deletions

View file

@ -1,8 +1,8 @@
[package]
name = "ironrdp"
version = "0.5.0"
description = "A Rust implementation of the Microsoft Remote Desktop Protocol (RDP)"
readme.workspace = true
readme = "README.md"
description = "A meta crate re-exporting IronRDP crates for convenience"
edition.workspace = true
license.workspace = true
homepage.workspace = true

7
crates/ironrdp/README.md Normal file
View file

@ -0,0 +1,7 @@
# IronRDP meta crate
A meta crate re-exporting IronRDP crates for convenience.
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -1,4 +1,4 @@
#![doc = include_str!("../../../README.md")]
#![doc = include_str!("../README.md")]
#![doc(
html_logo_url = "https://webdevolutions.blob.core.windows.net/images/projects/devolutions/logos/devolutions-icon-shadow.svg"
)]