mirror of
https://github.com/Devolutions/IronRDP.git
synced 2025-08-04 15:18:17 +00:00
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:
parent
36da11c02e
commit
bab049aa00
4 changed files with 10 additions and 4 deletions
|
@ -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
7
crates/ironrdp/README.md
Normal 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
|
|
@ -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"
|
||||
)]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue