Skip to content

Commit 4ef36bf

Browse files
elmarcoCBenoit
authored andcommitted
docs: add project links to READMEs for consistency
Signed-off-by: Marc-André Lureau <[email protected]>
1 parent f55e82f commit 4ef36bf

File tree

22 files changed

+90
-5
lines changed

22 files changed

+90
-5
lines changed

crates/ironrdp-acceptor/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,7 @@
33
State machines to drive an RDP connection acceptance sequence.
44

55
For now, it requires the [Tokio runtime](https://tokio.rs/).
6+
7+
This crate is part of the [IronRDP] project.
8+
9+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-ainput/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@
22

33
Implements the "Advanced Input" dynamic channel as defined from [Freerdp][here].
44

5+
This crate is part of the [IronRDP] project.
6+
57
[here]: https://github.com/FreeRDP/FreeRDP/blob/master/include/freerdp/channels/ainput.h
8+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-async/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP Async
22

33
`Future`s built on top of `ironrdp-connector` and `ironrdp-session` crates.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-blocking/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,8 @@ Blocking I/O abstraction wrapping the IronRDP state machines conveniently.
44

55
This crate is a higher level abstraction for IronRDP state machines using blocking I/O instead of
66
asynchronous I/O. This results in a simpler API with fewer dependencies that may be used
7-
instead of `ironrdp-async` when concurrency is not a requirement.
7+
instead of `ironrdp-async` when concurrency is not a requirement.
8+
9+
This crate is part of the [IronRDP] project.
10+
11+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-client-glutin/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@
66
cargo run --bin ironrdp-gui-client -- -u SimpleUsername -p SimplePassword! --avc444 --thin-client --small-cache --capabilities 0xf 192.168.1.100:3389
77
```
88
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
9-
in the renderer.
9+
in the renderer.
10+
11+
This crate is part of the [IronRDP] project.
12+
13+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-client/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,8 @@ SSLKEYLOGFILE=/tmp/tls-secrets ironrdp-client <HOSTNAME> --username <USERNAME> -
4141

4242
See this [awakecoding's repository][awakecoding-repository] explaining how to use the file in wireshark.
4343

44+
This crate is part of the [IronRDP] project.
45+
46+
[IronRDP]: https://github.com/Devolutions/IronRDP
4447
[awakecoding-repository]: https://github.com/awakecoding/wireshark-rdp#sslkeylogfile
4548

crates/ironrdp-cliprdr-format/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,7 @@ It would be easy to cause an overflow on a 16-bit architecture.
1010
However, it’s hard to imagine an RDP client running on such machines.
1111
Size of pointers on such architectures greatly limits the maximum size of the bitmap buffers.
1212
It’s likely the RDP client will choke on a big payload before overflowing because of this crate.
13+
14+
This crate is part of the [IronRDP] project.
15+
16+
[IronRDP]: https://github.com/Devolutions/IronRDP
+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP CLIPRDR native backends
22

3-
Native CLIPRDR backend implementations. Currently only Windows is supported.
3+
Native CLIPRDR backend implementations. Currently only Windows is supported.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-cliprdr/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,7 @@ This library includes:
88
- Clipboard backend API types for implementing OS-specific clipboard logic
99

1010
For concrete native clipboard backend implementations, see `ironrdp-cliprdr-native` crate.
11+
12+
This crate is part of the [IronRDP] project.
13+
14+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-connector/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP Connector
22

33
Abstract state machine to drive an RDP connection sequence.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-graphics/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP Graphics
22

33
Image processing primitives and algorithms for RDP (ZGFX, DWT…).
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-input/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP Input
22

33
Helpers to build RDP FastPathInput packets.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-pdu/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,9 @@ are considered to be known and defined. In such cases, `from_bits` also never fa
468468
precisely the same as `from_bits_retain`, except it’s less ergonomic because it returns a `Result`
469469
which must be needlessly handled.
470470

471+
This crate is part of the [IronRDP] project.
472+
473+
[IronRDP]: https://github.com/Devolutions/IronRDP
471474
[bitflags]: https://crates.io/crates/bitflags
472475
[from_bits]: https://docs.rs/bitflags/2.4.0/bitflags/example_generated/struct.Flags.html#method.from_bits
473476
[from_bits_truncate]: https://docs.rs/bitflags/2.4.0/bitflags/example_generated/struct.Flags.html#method.from_bits_truncate

crates/ironrdp-rdcleanpath/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP RDCleanPath
22

33
RDCleanPath PDU structure used by IronRDP and Devolutions Gateway.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-rdpdr/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,7 @@ Implements the RDPDR static virtual channel as described in
44
[\[MS-RDPEFS\]: Remote Desktop Protocol: File System Virtual Channel Extension][spec]
55

66
[spec]: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpefs/34d9de58-b2b5-40b6-b970-f82d4603bdb5
7+
8+
This crate is part of the [IronRDP] project.
9+
10+
[IronRDP]: https://github.com/Devolutions/IronRDP
+5-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
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.
1+
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.
2+
3+
This crate is part of the [IronRDP] project.
4+
5+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-server/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,7 @@ The server currently supports:
2323
Custom logic for your RDP server can be added by implementing these traits:
2424
- `RdpServerInputHandler` - callbacks used when the server receives input events from a client
2525
- `RdpServerDisplay` - notifies the server of display updates
26+
27+
This crate is part of the [IronRDP] project.
28+
29+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-session/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP Session
22

33
Abstract state machine to drive an RDP session.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-svc/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# IronRDP SVC
22

3-
IronRDP traits to implement RDP static virtual channels.
3+
IronRDP traits to implement RDP static virtual channels.
4+
5+
This crate is part of the [IronRDP] project.
6+
7+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-tls/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,7 @@ ironrdp-tls = { version = "x.y.z", default-features = false }
5757
(This is worse when the crate is exposing other default features which are typically not disabled by default.)
5858

5959
The stubbed backend is provided as an easy way to make the code compiles with minimal dependencies if required.
60+
61+
This crate is part of the [IronRDP] project.
62+
63+
[IronRDP]: https://github.com/Devolutions/IronRDP

crates/ironrdp-web/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,7 @@
55
```
66
wasm-pack build
77
```
8+
9+
This crate is part of the [IronRDP] project.
10+
11+
[IronRDP]: https://github.com/Devolutions/IronRDP

web-client/iron-svelte-client/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,7 @@ You can then start the dev server with either:
8787

8888
You can build distribution files with `npm run build`.
8989
Files are to be found in `./iron-svelte-client/build/browser`.
90+
91+
This crate is part of the [IronRDP] project.
92+
93+
[IronRDP]: https://github.com/Devolutions/IronRDP

0 commit comments

Comments
 (0)