Add initial documentation for criu-image-streamer

[manognapolikepad-lab]

This PR adds an initial, high-level documentation file for criu-image-streamer.

The goal is to provide a brief overview and usage context for users.
This is intended as a starting point and can be expanded or adjusted as needed.

Refs: #1099

[avagin]

Overall, the documentation looks good. Please add a Signed-off-by line to your commit message. And I think it should be better to wrap lines at 80 characters in the doc.

[manognapolikepad-lab]

Thanks for the review!
I’ve now wrapped the lines to 80 characters and pushed an update.
Please let me know if anything else needs changes.

[rst0git]

Refs: #1099

@manognapolikepad-lab I believe the issue is referring to adding docs for criu-image-streamer in https://criu.org.
When criu-image-streamer was introduced, it replaced the image cache/proxy implementation described in the following pages. For example, the --remote option in CRIU was replaced with --stream, but the wiki has not been updated.

• https://criu.org/Image_cache/proxy_TODO
• https://criu.org/CLI/opt/--remote

To contribute to the wiki pages, you can request an account here: https://criu.org/Special:RequestAccount

[manognapolikepad-lab]

Thanks for the suggestion! I’ve renamed the file to .md

[manognapolikepad-lab]

Thanks for the clarification!
I’ve updated the documentation to clarify that the helper script is
used for building in tests, and added a link to the official
installation instructions.

[manognapolikepad-lab]

Refs: #1099

@manognapolikepad-lab I believe the issue is referring to adding docs for criu-image-streamer in https://criu.org. When criu-image-streamer was introduced, it replaced the image cache/proxy implementation described in the following pages. For example, the --remote option in CRIU was replaced with --stream, but the wiki has not been updated.

• https://criu.org/Image_cache/proxy_TODO
• https://criu.org/CLI/opt/--remote

To contribute to the wiki pages, you can request an account here: https://criu.org/Special:RequestAccount

Thanks for the clarification!
That makes sense — I see how the issue is referring to the outdated
criu.org wiki pages.

For this PR, I’ve focused on adding initial documentation in the CRIU
repository. I’ll look into contributing updates to the wiki pages
separately.

[github-actions]

A friendly reminder that this PR had no activity for 30 days.