Improving the README documentation - #4
Merged
Merged
Conversation
Copilot created this pull request from a session on behalf of
natedemoss
June 18, 2026 04:01
View session
There was a problem hiding this comment.
Pull request overview
Updates the project README to be more concise and structured as a quick-start oriented landing page for the cf-recommend CLI.
Changes:
- Replaces the “Why cf-recommend?” section with a condensed “Features” section and streamlined demo output.
- Reorganizes usage documentation into “Quick Start”, “Commands”, and “next Command Options”.
- Condenses the “How it works”, caching, and build-from-source sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| A fast, local-first **CLI** that analyses your Codeforces submission history and | ||
| recommends the best problems to solve next — laser-focused on your weak topics. | ||
| **Know exactly what to practice next on Codeforces.** A fast, local-first CLI that analyzes your submission history and recommends problems tailored to your weak topics. |
Comment on lines
+71
to
+73
| | `cf weak-topics` | Weakest topics with insights | | ||
| | `cf progress` | Recent activity & improvements | | ||
| | `cf config [key value]` | View or change settings | |
Comment on lines
+81
to
+83
| | `--difficulty A-B` | Rating range (e.g., `1400-1600`) | | ||
| | `--max-rating N` | Cap problem rating at N | | ||
| | `--weak-topics-only` | Only problems from weak topics | |
|
|
||
| A weak topic makes a problem *feel* harder, so the effective rating adds up to | ||
| +200 for your weakest involved tag: | ||
| **Per-User Difficulty:** Weak topics add up to +200 to a problem's effective rating for you. |
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
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.
Pull request created by AI Agent