docs: add README quick start #673

Merged

barrettruth merged 1 commit from docs/666-readme-quick-start into main

2026-05-09 02:39:17 +00:00

barrettruth commented

2026-05-09 00:58:02 +00:00

Owner

Problem

The README tells users what forge.nvim does, but it does not give a short first-run path for checking dependencies or opening the main workflows.

Solution

Add a compact quick-start section with :checkhealth forge, direct :Forge examples, and the interactive workflow picker. Also include releases in the feature list.

Closes #666

Verification

nix develop .#ci --command just format
nix develop .#ci --command just ci

Remote Forgejo CI was not awaited because the Spark runner is currently down.

## Problem The README tells users what forge.nvim does, but it does not give a short first-run path for checking dependencies or opening the main workflows. ## Solution Add a compact quick-start section with `:checkhealth forge`, direct `:Forge` examples, and the interactive workflow picker. Also include releases in the feature list. Closes #666 ## Verification - `nix develop .#ci --command just format` - `nix develop .#ci --command just ci` Remote Forgejo CI was not awaited because the Spark runner is currently down.

barrettruth added 1 commit

2026-05-09 00:58:02 +00:00

docs: add README quick start

quality / Format (pull_request) Successful in 13s

Details

quality / Lint (pull_request) Successful in 15s

Details

quality / Test (pull_request) Successful in 11s

Details

c90c4f0a32