Restructure README around what/how-to-run/how-to-contribute - #52
Draft
chrisuthe wants to merge 4 commits into
Draft
Restructure README around what/how-to-run/how-to-contribute#52chrisuthe wants to merge 4 commits into
chrisuthe wants to merge 4 commits into
Conversation
Split the developer-focused README into an end-user README, a new contributors.md for build/test/release guidance, and a wiki Advanced-Usage page for connection modes, output selection, logging, buffering, identity and stream hooks. The wiki is now the complete end-user reference beyond the README's quick start. Also removes every remaining squeezelite reference from docs and source comments (including --help output), and fixes several broken self-referential wiki links and one --help inaccuracy (there is no --daemonize long alias for -z) introduced while restructuring.
The new doc ships via install(), so the three hard-coded expected-file lists -- the staged payload and the macOS pkg receipt in build.yml, and the staged payload in build-armv6.yml -- all failed on a diff. Add it to each, and to the payload table in the Running as a Service page.
A reader who gets as far as starting a player next wants to name it, choose a sound card, pin a format, or point it at a server. Those were a wiki hop away. Also corrects the licence line, which said MIT over an Apache 2.0 LICENSE.
The player is feature-complete for everyday use, so leading both the README and the wiki landing page with a caveat about missing features misrepresents it. The roadmap is still there for anyone who wants the detail.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Restructures the documentation around three end-user questions: what is it, how do I run it, and how do I contribute.
Home.md,_Sidebar.md) and cross-links so the wiki is the complete end-user reference, and fixed several broken self-referential links that an earlier pass had introduced.--helpoutput, replacing them with protocol/behavior-neutral wording.--help/wiki inaccuracy: there is no--daemonizelong alias for-z(verified againstsrc/cli.cpp's getopt table).Why
The README had become a full technical reference (CMake options, CI matrix internals, release tagging rules) that isn't useful to someone who just wants to run the player. Moving that material to
contributors.mdand the wiki keeps the README focused, and the wiki now clearly owns everything beyond the quick start.Notes for reviewers
src/andtests/are comment/help-text wording only (squeezelite reference removal); no behavior changes. Verified against the option table and existing--help-asserting tests, but this environment has no CMake/ctest available to run the suite directly.contributors.mdis added to the CMake install payload (CMakeLists.txt) alongsideREADME.md.