📝 Add a self-contained README (closes #1) #3
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "upfixb02rkd/dynapt:docs/issue-1-self-contained-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Problem
Closes #1 ("Readme?"). The repository root shipped only a 40-byte
README.mdstub, and the full setup/usage documentation lived in a random gist that readers had to find through an issue comment. New users had no in-repo way to learn how to install, configure, run or recover dynapt.Root cause
Documentation was never committed to the repository; the tutorial was written as an external gist and linked ad-hoc from an issue. There was no contributor-facing reference for the actual CLI and configuration surface.
Solution
Replace the placeholder
README.mdwith a single self-contained guide. The content regrounds the gist on the current source (main.js,src/,lib/) and covers:amd64/arm64DEBs published at/opt/dynapt; also source build/run with Deno.config.jsonschema —port,concurrency,apps,githubAccessToken; per-appname,url/github(repo/filter/prerelease),appimage(withbin),jq, and the auto-generated Joi-validatedidused as cache key.dynapt/serve) and@rebootautostart; every CLI command frommain.js—serve,list,update,clean,version.dpkg-scanpackages→apt-ftparchiveRelease).clean,update, targetedapt update), a project layout table, and roadmap/status.Only
README.mdis changed (additive documentation). No code, build scripts or configuration were touched.Verification (run locally in this checkout)
bash -n build.sh permissions.sh dynapt— all OK../pathlink in the README resolves to an existing file (15 targets); all pass.docs/issue-1-self-contained-readmewas cut frommasterat9b8fa75; commit range relative to upstream/master is exactly one commit touching onlyREADME.md(1 file, +328/-1).Deno is not installed in the contribution sandbox, so the live server/CLI could not be executed here; documentation text was cross-checked directly against
main.js,src/andlib/instead.Impact scope
README.mdonly.🤖 Generated with Flcast Code / CLIAgent for the fork-based open source contribution exercise.
Hi,
As explained in #1 and in PR #2, the current shape of this project is temporary, so I won't add docs now for something temporary.
Thank you
Pull request closed