docs: use README.md for crates lib.rs doc

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>

crates/ironrdp-acceptor/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-ainput/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use bitflags::bitflags;
 use ironrdp_dvc::DvcEncode;
 use num_derive::{FromPrimitive, ToPrimitive};

crates/ironrdp-async/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-blocking/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-client/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(unused_crate_dependencies)] // false positives because there is both a library and a binary
 
 // No need to be as strict as in production libraries

crates/ironrdp-connector/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-core/src/lib.rs

@@ -1,5 +1,5 @@
-#![cfg_attr(not(feature = "std"), no_std)]
 #![doc = include_str!("../README.md")]
+#![cfg_attr(not(feature = "std"), no_std)]
 #![warn(clippy::std_instead_of_alloc)]
 #![warn(clippy::std_instead_of_core)]
 #![warn(missing_docs)]

crates/ironrdp-dvc/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[macro_use]

crates/ironrdp-error/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 #[cfg(feature = "alloc")]

crates/ironrdp-futures/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[rustfmt::skip] // do not re-order this pub use
 pub use ironrdp_async::*;
 

crates/ironrdp-glutin-renderer/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-graphics/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::arithmetic_side_effects)] // FIXME: remove
 #![allow(clippy::cast_lossless)] // FIXME: remove
 #![allow(clippy::cast_possible_truncation)] // FIXME: remove

crates/ironrdp-input/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use bitvec::array::BitArray;
 use bitvec::BitArr;
 use ironrdp_pdu::input::fast_path::{FastPathInputEvent, KeyboardFlags};

crates/ironrdp-pdu-generators/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 // No need to be as strict as in production libraries
 #![allow(clippy::arithmetic_side_effects)]
 #![allow(clippy::cast_lossless)]

crates/ironrdp-pdu/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::arithmetic_side_effects)] // FIXME: remove
 #![allow(clippy::cast_lossless)] // FIXME: remove
 #![allow(clippy::cast_possible_truncation)] // FIXME: remove

crates/ironrdp-rdcleanpath/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use core::fmt;
 
 use der::asn1::OctetString;

crates/ironrdp-rdpsnd-native/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[macro_use]
 extern crate tracing;
 

crates/ironrdp-rdpsnd/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 pub mod client;
 pub mod pdu;
 pub mod server;

crates/ironrdp-server/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::arithmetic_side_effects)] // TODO: should we enable this lint back?
 
 pub use tokio;

crates/ironrdp-session-generators/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 // No need to be as strict as in production libraries
 #![allow(clippy::arithmetic_side_effects)]
 #![allow(clippy::cast_lossless)]

crates/ironrdp-session/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::arithmetic_side_effects)] // FIXME: remove
 
 #[macro_use]

crates/ironrdp-svc/src/lib.rs

@@ -1,4 +1,5 @@
 #![doc = include_str!("../README.md")]
+
 // TODO: #![warn(missing_docs)]
 
 extern crate alloc;

crates/ironrdp-tokio/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 #[rustfmt::skip] // do not re-order this pub use
 pub use ironrdp_async::*;
 

crates/ironrdp-web/src/lib.rs

@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![allow(clippy::new_without_default)] // Default trait can’t be used by wasm consumer anyway
 #![allow(unsafe_op_in_unsafe_fn)] // We can’t control code generated by `wasm-bindgen`
 

crates/ironrdp/src/lib.rs

@@ -1,6 +1,4 @@
-//! Rust implementation of the Remote Desktop Protocol (RDP).
-//!
-//! This is a meta crate re-exporting other ironrdp crates for convenience.
+#![doc = include_str!("../../../README.md")]
 
 #[cfg(feature = "acceptor")]
 pub use ironrdp_acceptor as acceptor;

crates/now-proto-pdu/src/lib.rs

@@ -1,6 +1,4 @@
-//! This crate provides implementation of [NOW_PROTO] protocol.
-//!
-//! [NOW_PROTO]: ../../../docs/NOW-spec.md
+#![doc = include_str!("../README.md")]
 #![cfg_attr(not(feature = "std"), no_std)]
 
 extern crate alloc;