docs: add installation instructions and distribution methods to README#69
Merged
docs: add installation instructions and distribution methods to README#69
Conversation
Co-authored-by: szmyty <14865041+szmyty@users.noreply.github.com> Agent-Logs-Url: https://github.com/egohygiene/renderflow/sessions/97c3ad0e-7504-411e-b988-33adb517e200
Copilot
AI
changed the title
[WIP] Add installation instructions and distribution methods
docs: add installation instructions and distribution methods to README
Mar 23, 2026
szmyty
approved these changes
Mar 23, 2026
Pull Request Summary by devActivityMetricsAchievements
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README contained only a one-line title with no guidance on how to install or use the tool.
Changes
Installation (
README.md)curlone-liners for Linux/macOS (download →chmod +x→ move to/usr/local/bin/); Windows instructions to grabrenderflow-windows.exeand add toPATHcargo install --path .Usage
Includes a clarifying note that the positional argument is always a YAML config file — the Markdown source is declared inside it via
input:— to prevent confusion with therenderflow input.mdshorthand pattern.Minimal config example
Shows a working
renderflow.yamlstub so users know what to create before running the tool.Original prompt
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.