docs: add project links to READMEs for consistency

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
This commit is contained in:
Marc-André Lureau 2024-10-29 12:07:51 +04:00 committed by Benoît Cortier
parent f55e82f02e
commit 4ef36bf5fa
22 changed files with 90 additions and 5 deletions

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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.
instead of `ironrdp-async` when concurrency is not a requirement.
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -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.
in the renderer.
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -41,5 +41,8 @@ SSLKEYLOGFILE=/tmp/tls-secrets ironrdp-client <HOSTNAME> --username <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

View file

@ -10,3 +10,7 @@ It would be easy to cause an overflow on a 16-bit architecture.
However, its 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.
Its 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

View file

@ -1,3 +1,7 @@
# IronRDP CLIPRDR native backends
Native CLIPRDR backend implementations. Currently only Windows is supported.
Native CLIPRDR backend implementations. Currently only Windows is supported.
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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

View file

@ -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 its 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

View file

@ -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

View file

@ -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

View file

@ -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.
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

View file

@ -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

View file

@ -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

View file

@ -1,3 +1,7 @@
# IronRDP SVC
IronRDP traits to implement RDP static virtual channels.
IronRDP traits to implement RDP static virtual channels.
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -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

View file

@ -5,3 +5,7 @@
```
wasm-pack build
```
This crate is part of the [IronRDP] project.
[IronRDP]: https://github.com/Devolutions/IronRDP

View file

@ -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