Skip to content

docs: add installation instructions and distribution methods to README#69

Merged
szmyty merged 2 commits intomainfrom
copilot/add-installation-instructions
Mar 23, 2026
Merged

docs: add installation instructions and distribution methods to README#69
szmyty merged 2 commits intomainfrom
copilot/add-installation-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 23, 2026

README contained only a one-line title with no guidance on how to install or use the tool.

Changes

Installation (README.md)

  • GitHub Releasescurl one-liners for Linux/macOS (download → chmod +x → move to /usr/local/bin/); Windows instructions to grab renderflow-windows.exe and add to PATH
  • Build from sourcecargo install --path .

Usage

renderflow build                        # default renderflow.yaml
renderflow build --config custom.yaml   # custom config
renderflow my-project.yaml              # shorthand
renderflow build --dry-run              # preview without output

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 the renderflow input.md shorthand pattern.

Minimal config example

Shows a working renderflow.yaml stub so users know what to create before running the tool.

Original prompt

This section details on the original issue you should resolve

<issue_title>📥 Add installation instructions and distribution methods</issue_title>
<issue_description>### Title: 📥 Add installation instructions and distribution methods


Description

Document how users can install and use Renderflow.


Goals

  • Provide simple install methods
  • Improve onboarding experience

Requirements

Include instructions for:

  • Downloading from GitHub Releases
  • Running binary directly
  • Optional:
cargo install --path .
  • Usage examples:
renderflow input.md

Acceptance Criteria

  • Instructions clear and concise
  • Covers common platforms
  • Easy to follow
    </issue_description>

Comments on the Issue (you are @copilot in this section)


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI changed the title [WIP] Add installation instructions and distribution methods docs: add installation instructions and distribution methods to README Mar 23, 2026
Copilot AI requested a review from szmyty March 23, 2026 16:16
@szmyty szmyty marked this pull request as ready for review March 23, 2026 16:20
@szmyty szmyty merged commit d039f27 into main Mar 23, 2026
@devactivity-app
Copy link
Copy Markdown

Pull Request Summary by devActivity

Metrics

Cycle Time: 7m Coding Time: < 1 min Pickup Time: 3m Review Time: < 1 min

Achievements

@szmyty szmyty deleted the copilot/add-installation-instructions branch March 23, 2026 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📥 Add installation instructions and distribution methods

2 participants