Repository navigation
docs: rewrite README with English on top, expanded usage, and badges - #1
Merged
Merged
Conversation
- English section moved to the top, original Japanese content kept below it in full (translated/updated to match, nothing removed). - Removed the pip/PyPI and apt/bloom publishing walkthroughs from the README -- not useful to someone just using the package; moved to .docs/PUBLISHING.md for maintainers instead (see that PR). - Expanded the usage section: full colcon lbuild/lb option reference (--event-handlers, --continue-on-error, --parallel-workers/-j/--jobs), colcon lclean/lc options, how to try the bundled demo workspace, how to use the live_status event handler without the verbs, locale detection for this package's own help text, and non-TTY behavior. - Added CI / PyPI version / Python versions / license badges at the top. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
.docs/PUBLISHING.mdfor maintainers instead, see chore: make setup.cfg comments bilingual, resolve stale TODOs #2.colcon lbuild/lboption reference (--event-handlers,--continue-on-error,--parallel-workers/-j/--jobs),colcon lclean/lcoptions, how to try the bundled demo workspace, using thelive_statusevent handler without the verbs, locale detection for this package's own help text, and non-TTY behavior.Why
Requested: English-first README for a wider audience, more detail on day-to-day
colcon-live-toolsusage, and a more presentable landing page (badges) for visitors.🤖 Generated with Claude Code