Skip to content

Rewrite README around user questions - #12

Merged
FaulMit merged 1 commit into
mainfrom
agent/question-driven-readme
Aug 2, 2026
Merged

Rewrite README around user questions#12
FaulMit merged 1 commit into
mainfrom
agent/question-driven-readme

Conversation

@FaulMit

@FaulMit FaulMit commented Aug 2, 2026

Copy link
Copy Markdown
Owner

What changed

  • define Captail's primary audience as Windows players who want focused, resilient instant replay
  • reorganize the README around real user questions instead of a repeated feature inventory
  • explain installation, first replay, capture modes, recovery, RAM use, codecs, real 240 FPS, audio tracks, editing, privacy, compatibility, and bug reports
  • add the current v0.1.5 main-window screenshot uploaded to main
  • remove stale v0.1.4 release framing and broken screenshot references
  • keep contributor and license information concise at the end

User impact

A new visitor can decide whether Captail fits their needs, install the correct package, understand important recording trade-offs, and report useful hardware-specific issues without reading implementation details first.

Validation

  • rendered successfully through GitHub's GFM API
  • all 10 local links and image paths resolve
  • English-only repository content verified
  • git diff --check passed
  • claims checked against current v0.1.5 code and release metadata

@FaulMit
FaulMit marked this pull request as ready for review August 2, 2026 22:07
@FaulMit
FaulMit merged commit 68f38ab into main Aug 2, 2026
4 of 5 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ccdc5d9c13

ℹ️ 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".

Comment thread README.md
Comment on lines +255 to +259
dotnet restore .\src\Captail\Captail.csproj --locked-mode
dotnet build .\Captail.sln -c Debug --no-restore
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines and [docs/RELEASING.md](docs/RELEASING.md) for the automated release process.

## Architecture
The first build acquires the pinned OBS and FFmpeg runtimes when they are missing.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Acquire OBS before the documented clean build

On a clean Windows checkout, these commands download OBS during the build, but MSBuild evaluates the top-level OBS Content globs in Captail.csproj before the AcquireObsRuntime target runs. Consequently, the first output lacks obs.dll, plugins, and data, so Captail cannot run until it is built again. Restore the explicit tools\AcquireObsRuntime.ps1 step used by the CI workflow and previous README, or change the project to copy OBS through target-time item evaluation as it does for FFmpeg.

Useful? React with 👍 / 👎.

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.

1 participant