From 4ef36bf5fa3655ef5c34e0439030627450bf8d08 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Tue, 29 Oct 2024 12:07:51 +0400 Subject: [PATCH] docs: add project links to READMEs for consistency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marc-André Lureau --- crates/ironrdp-acceptor/README.md | 4 ++++ crates/ironrdp-ainput/README.md | 3 +++ crates/ironrdp-async/README.md | 4 ++++ crates/ironrdp-blocking/README.md | 6 +++++- crates/ironrdp-client-glutin/README.md | 6 +++++- crates/ironrdp-client/README.md | 3 +++ crates/ironrdp-cliprdr-format/README.md | 4 ++++ crates/ironrdp-cliprdr-native/README.md | 6 +++++- crates/ironrdp-cliprdr/README.md | 4 ++++ crates/ironrdp-connector/README.md | 4 ++++ crates/ironrdp-graphics/README.md | 4 ++++ crates/ironrdp-input/README.md | 4 ++++ crates/ironrdp-pdu/README.md | 3 +++ crates/ironrdp-rdcleanpath/README.md | 4 ++++ crates/ironrdp-rdpdr/README.md | 4 ++++ crates/ironrdp-replay-client/README.md | 6 +++++- crates/ironrdp-server/README.md | 4 ++++ crates/ironrdp-session/README.md | 4 ++++ crates/ironrdp-svc/README.md | 6 +++++- crates/ironrdp-tls/README.md | 4 ++++ crates/ironrdp-web/README.md | 4 ++++ web-client/iron-svelte-client/README.md | 4 ++++ 22 files changed, 90 insertions(+), 5 deletions(-) diff --git a/crates/ironrdp-acceptor/README.md b/crates/ironrdp-acceptor/README.md index 4ffc9ca5..63695d65 100644 --- a/crates/ironrdp-acceptor/README.md +++ b/crates/ironrdp-acceptor/README.md @@ -3,3 +3,7 @@ State machines to drive an RDP connection acceptance sequence. For now, it requires the [Tokio runtime](https://tokio.rs/). + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-ainput/README.md b/crates/ironrdp-ainput/README.md index e5febaec..71c85114 100644 --- a/crates/ironrdp-ainput/README.md +++ b/crates/ironrdp-ainput/README.md @@ -2,4 +2,7 @@ Implements the "Advanced Input" dynamic channel as defined from [Freerdp][here]. +This crate is part of the [IronRDP] project. + [here]: https://github.com/FreeRDP/FreeRDP/blob/master/include/freerdp/channels/ainput.h +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-async/README.md b/crates/ironrdp-async/README.md index fcd5caa2..fa2e7234 100644 --- a/crates/ironrdp-async/README.md +++ b/crates/ironrdp-async/README.md @@ -1,3 +1,7 @@ # IronRDP Async `Future`s built on top of `ironrdp-connector` and `ironrdp-session` crates. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-blocking/README.md b/crates/ironrdp-blocking/README.md index d1d3cc74..6aa4708f 100644 --- a/crates/ironrdp-blocking/README.md +++ b/crates/ironrdp-blocking/README.md @@ -4,4 +4,8 @@ Blocking I/O abstraction wrapping the IronRDP state machines conveniently. This crate is a higher level abstraction for IronRDP state machines using blocking I/O instead of asynchronous I/O. This results in a simpler API with fewer dependencies that may be used -instead of `ironrdp-async` when concurrency is not a requirement. \ No newline at end of file +instead of `ironrdp-async` when concurrency is not a requirement. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-client-glutin/README.md b/crates/ironrdp-client-glutin/README.md index df2473fe..a5470545 100644 --- a/crates/ironrdp-client-glutin/README.md +++ b/crates/ironrdp-client-glutin/README.md @@ -6,4 +6,8 @@ cargo run --bin ironrdp-gui-client -- -u SimpleUsername -p SimplePassword! --avc444 --thin-client --small-cache --capabilities 0xf 192.168.1.100:3389 ``` 3. If the GUI has artifacts it can be dumped to a file using the gfx_dump_file parameter. Later the ironrdp-replay-client binary can be used to debug and fix any issues - in the renderer. \ No newline at end of file + in the renderer. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-client/README.md b/crates/ironrdp-client/README.md index ad85f116..95a9f90f 100644 --- a/crates/ironrdp-client/README.md +++ b/crates/ironrdp-client/README.md @@ -41,5 +41,8 @@ SSLKEYLOGFILE=/tmp/tls-secrets ironrdp-client --username - See this [awakecoding's repository][awakecoding-repository] explaining how to use the file in wireshark. +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP [awakecoding-repository]: https://github.com/awakecoding/wireshark-rdp#sslkeylogfile diff --git a/crates/ironrdp-cliprdr-format/README.md b/crates/ironrdp-cliprdr-format/README.md index 7dfe8aad..aa0f3ac0 100644 --- a/crates/ironrdp-cliprdr-format/README.md +++ b/crates/ironrdp-cliprdr-format/README.md @@ -10,3 +10,7 @@ It would be easy to cause an overflow on a 16-bit architecture. However, it’s hard to imagine an RDP client running on such machines. Size of pointers on such architectures greatly limits the maximum size of the bitmap buffers. It’s likely the RDP client will choke on a big payload before overflowing because of this crate. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-cliprdr-native/README.md b/crates/ironrdp-cliprdr-native/README.md index 17d28f15..42c396b7 100644 --- a/crates/ironrdp-cliprdr-native/README.md +++ b/crates/ironrdp-cliprdr-native/README.md @@ -1,3 +1,7 @@ # IronRDP CLIPRDR native backends -Native CLIPRDR backend implementations. Currently only Windows is supported. \ No newline at end of file +Native CLIPRDR backend implementations. Currently only Windows is supported. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-cliprdr/README.md b/crates/ironrdp-cliprdr/README.md index ac218a4d..ca9b97a3 100644 --- a/crates/ironrdp-cliprdr/README.md +++ b/crates/ironrdp-cliprdr/README.md @@ -8,3 +8,7 @@ This library includes: - Clipboard backend API types for implementing OS-specific clipboard logic For concrete native clipboard backend implementations, see `ironrdp-cliprdr-native` crate. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-connector/README.md b/crates/ironrdp-connector/README.md index afba262a..4c42afad 100644 --- a/crates/ironrdp-connector/README.md +++ b/crates/ironrdp-connector/README.md @@ -1,3 +1,7 @@ # IronRDP Connector Abstract state machine to drive an RDP connection sequence. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-graphics/README.md b/crates/ironrdp-graphics/README.md index 253f023d..ac5c92bb 100644 --- a/crates/ironrdp-graphics/README.md +++ b/crates/ironrdp-graphics/README.md @@ -1,3 +1,7 @@ # IronRDP Graphics Image processing primitives and algorithms for RDP (ZGFX, DWT…). + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-input/README.md b/crates/ironrdp-input/README.md index 3d9efa68..cae918d2 100644 --- a/crates/ironrdp-input/README.md +++ b/crates/ironrdp-input/README.md @@ -1,3 +1,7 @@ # IronRDP Input Helpers to build RDP FastPathInput packets. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-pdu/README.md b/crates/ironrdp-pdu/README.md index c3304f6c..f5cb09b2 100644 --- a/crates/ironrdp-pdu/README.md +++ b/crates/ironrdp-pdu/README.md @@ -468,6 +468,9 @@ are considered to be known and defined. In such cases, `from_bits` also never fa precisely the same as `from_bits_retain`, except it’s less ergonomic because it returns a `Result` which must be needlessly handled. +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP [bitflags]: https://crates.io/crates/bitflags [from_bits]: https://docs.rs/bitflags/2.4.0/bitflags/example_generated/struct.Flags.html#method.from_bits [from_bits_truncate]: https://docs.rs/bitflags/2.4.0/bitflags/example_generated/struct.Flags.html#method.from_bits_truncate diff --git a/crates/ironrdp-rdcleanpath/README.md b/crates/ironrdp-rdcleanpath/README.md index dbddc686..30e28de6 100644 --- a/crates/ironrdp-rdcleanpath/README.md +++ b/crates/ironrdp-rdcleanpath/README.md @@ -1,3 +1,7 @@ # IronRDP RDCleanPath RDCleanPath PDU structure used by IronRDP and Devolutions Gateway. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-rdpdr/README.md b/crates/ironrdp-rdpdr/README.md index b186d6a4..7f18a040 100644 --- a/crates/ironrdp-rdpdr/README.md +++ b/crates/ironrdp-rdpdr/README.md @@ -4,3 +4,7 @@ Implements the RDPDR static virtual channel as described in [\[MS-RDPEFS\]: Remote Desktop Protocol: File System Virtual Channel Extension][spec] [spec]: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpefs/34d9de58-b2b5-40b6-b970-f82d4603bdb5 + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-replay-client/README.md b/crates/ironrdp-replay-client/README.md index 9a1d2706..8600a2ef 100644 --- a/crates/ironrdp-replay-client/README.md +++ b/crates/ironrdp-replay-client/README.md @@ -1 +1,5 @@ -Utility tool to parse data dumped through the RDP graphics pipeline and replay it. This tool is helpful to iterate and fix any issues in the rendering pipeline. \ No newline at end of file +Utility tool to parse data dumped through the RDP graphics pipeline and replay it. This tool is helpful to iterate and fix any issues in the rendering pipeline. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-server/README.md b/crates/ironrdp-server/README.md index 2d50f035..82a817b1 100644 --- a/crates/ironrdp-server/README.md +++ b/crates/ironrdp-server/README.md @@ -23,3 +23,7 @@ The server currently supports: Custom logic for your RDP server can be added by implementing these traits: - `RdpServerInputHandler` - callbacks used when the server receives input events from a client - `RdpServerDisplay` - notifies the server of display updates + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-session/README.md b/crates/ironrdp-session/README.md index e6879a32..dfaa1370 100644 --- a/crates/ironrdp-session/README.md +++ b/crates/ironrdp-session/README.md @@ -1,3 +1,7 @@ # IronRDP Session Abstract state machine to drive an RDP session. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-svc/README.md b/crates/ironrdp-svc/README.md index 5fa66f08..dd8813d3 100644 --- a/crates/ironrdp-svc/README.md +++ b/crates/ironrdp-svc/README.md @@ -1,3 +1,7 @@ # IronRDP SVC -IronRDP traits to implement RDP static virtual channels. \ No newline at end of file +IronRDP traits to implement RDP static virtual channels. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-tls/README.md b/crates/ironrdp-tls/README.md index cfd0bc69..f1f0b2bc 100644 --- a/crates/ironrdp-tls/README.md +++ b/crates/ironrdp-tls/README.md @@ -57,3 +57,7 @@ ironrdp-tls = { version = "x.y.z", default-features = false } (This is worse when the crate is exposing other default features which are typically not disabled by default.) The stubbed backend is provided as an easy way to make the code compiles with minimal dependencies if required. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/crates/ironrdp-web/README.md b/crates/ironrdp-web/README.md index a0516f0b..a619c2d9 100644 --- a/crates/ironrdp-web/README.md +++ b/crates/ironrdp-web/README.md @@ -5,3 +5,7 @@ ``` wasm-pack build ``` + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP diff --git a/web-client/iron-svelte-client/README.md b/web-client/iron-svelte-client/README.md index c55a44b4..ad3cece1 100644 --- a/web-client/iron-svelte-client/README.md +++ b/web-client/iron-svelte-client/README.md @@ -87,3 +87,7 @@ You can then start the dev server with either: You can build distribution files with `npm run build`. Files are to be found in `./iron-svelte-client/build/browser`. + +This crate is part of the [IronRDP] project. + +[IronRDP]: https://github.com/Devolutions/IronRDP