Repository navigation
* the README follows the house convention - #14
Conversation
The file opened with a hundred and forty lines of CLI help under no heading at all. That becomes a CLI reference section, and Vision, Features, Installation, Quick start and Building are added around it, so the first screen now says what the tool is and how to run it rather than listing every option. Overview, Practical considerations and Converting video keep their content and gain the emoji the vocabulary asks for. Switches the repo-readme check on so it stays that way.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 84659be6e0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## 📦 Installation | ||
|
|
||
| Download the executable from the [latest release](../../releases/latest) (or a `nightly-*` | ||
| prerelease). The GIF file-format primitives are also published on nuget.org as `GifFileFormat`. |
There was a problem hiding this comment.
The published package is Hawkynt.GifFileFormat (GifFileFormat/GifFileFormat.csproj sets that PackageId, and its package README uses dotnet add package Hawkynt.GifFileFormat). Naming it as GifFileFormat in the installation section directs users toward the wrong package identifier; use the full ID so the documented installation path is actionable.
Useful? React with 👍 / 👎.
| Every knob has a default that produces something reasonable; the [CLI reference](#-cli-reference) | ||
| below lists them. |
There was a problem hiding this comment.
The reference omits the currently registered --maxFrames, --frameDuration, --totalTime, --serpentine, and --disallowFillingColors options from AnythingToGif/CLI/Options.cs:135-148. Users relying on this new promise cannot discover several output-timing and dithering controls, so regenerate the embedded help or avoid claiming that every knob is listed.
Useful? React with 👍 / 👎.
|
|
||
| ```bash | ||
| dotnet build -c Release | ||
| dotnet test |
There was a problem hiding this comment.
On Linux or macOS, the newly documented dotnet test command cannot run this solution: the tests target net8.0-windows, and docs/LINUX-TEST-BLOCKER.md records the transitive Microsoft.WindowsDesktop.App.WindowsForms dependency as Windows-only. Add the Windows prerequisite or provide a platform-specific command so non-Windows contributors are not sent through a known failing setup.
Useful? React with 👍 / 👎.
1 participant
Brings this repository's README into line with the house convention now defined in
repo-readme/README.md,and switches the check on so it stays that way.
The README is a funnel: the pitch catches the reader,
🧭 Visionand✨ Featuressay what the thingis,
📦 Installationand🚀 Quick startget them running, the middle goes deeper, and what acontributor needs closes the file. One emoji means one thing, and a section shared with the package
README convention carries the same name and emoji in both.
No prose was dropped — sections were renamed, reordered, and where the convention asks for something
that was missing, it was written.