Skip to content

Clean up README for clarity#104

Merged
monkut merged 1 commit into
mainfrom
docs/readme-clarity-cleanup
Apr 30, 2026
Merged

Clean up README for clarity#104
monkut merged 1 commit into
mainfrom
docs/readme-clarity-cleanup

Conversation

@monkut

@monkut monkut commented Apr 30, 2026

Copy link
Copy Markdown
Owner

Summary

  • Fix muddled usage synopsis (had fix-ci listed twice with conflicting signatures)
  • Document 7 CLI flags and 4 environment variables that existed in code but were missing from the README
  • Compress the Authentication and Customizing Prompts sections without dropping operational detail
  • Refresh Project Structure (add runners.py, skills/)

No code changed — README only.

Test plan

  • Render the updated README on GitHub and confirm tables render correctly
  • Spot-check that every flag listed under "Options" matches askcc --help and each subcommand's --help
  • Spot-check env vars against askcc/settings.py

- Replace muddled usage synopsis (fix-ci listed twice) with a single form
- Split Options into Global vs Command-specific tables and add 7 missing
  flags (--ignore-labels, --language, --runner, --effort,
  --max-thinking-tokens, --disable-thinking, --disable-adaptive-thinking)
- Add 4 missing env vars (ASKCC_CLAUDE_EFFORT_LEVEL,
  ASKCC_CLAUDE_MAX_THINKING_TOKENS, ASKCC_CLAUDE_DISABLE_THINKING,
  ASKCC_CLAUDE_DISABLE_ADAPTIVE_THINKING)
- Compress Authentication and Customizing Prompts sections without
  losing operational detail
- Refresh Project Structure to include runners.py and skills/
@monkut monkut merged commit 5084178 into main Apr 30, 2026
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