Rewrite README around user questions - #12
Conversation
There was a problem hiding this comment.
💡 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".
| 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. |
There was a problem hiding this comment.
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 👍 / 👎.
What changed
mainUser 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
git diff --checkpassed