[PR #2068] [CLOSED] docs: add Quick Start section and improve structure

## 📋 Pull Request Information **Original PR:** https://github.com/CCExtractor/ccextractor/pull/2068 **Author:** [@pranavshar223](https://github.com/pranavshar223) **Created:** 1/27/2026 **Status:** ❌ Closed **Base:** `master` ← **Head:** `docs/readme-quick-start` --- ### 📝 Commits (1) - [`9031e02`](https://github.com/CCExtractor/ccextractor/commit/9031e0223d34ac257bc387f6b960ce1d51fddf70) docs(readme): add Quick Start section and improve structure ### 📊 Changes **1 file changed** (+35 additions, -11 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+35 -11) </details> ### 📄 Description  **In raising this pull request, I confirm the following (please check boxes):** - [ ] I have read and understood the [contributors guide](https://github.com/CCExtractor/ccextractor/blob/master/.github/CONTRIBUTING.md). - [ ] I have checked that another pull request for this purpose does not exist. - [ ] I have considered, and confirmed that this submission will be valuable to others. - [ ] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [ ] I give this submission freely, and claim no ownership to its content. - [ ] **I have mentioned this change in the [changelog](https://github.com/CCExtractor/ccextractor/blob/master/docs/CHANGES.TXT).** **My familiarity with the project is as follows (check one):** - [ ] I have never used CCExtractor. - [ ] I have used CCExtractor just a couple of times. - [ ] I absolutely love CCExtractor, but have not contributed previously. - [ ] I am an active contributor to CCExtractor. --- ### Summary This PR improves the README by adding a clear **Quick Start** section and improving the overall document flow, while avoiding duplication. ### What was changed - Added a **Quick Start** section near the top of the README - Included basic installation guidance and a minimal usage example - Moved the Quick Start before the Installation section for better onboarding - Removed duplicated usage instructions to avoid redundancy - Improved repository link formatting for clarity and consistency ### Why this change New users often want a fast way to: - understand what CCExtractor does - install it quickly - extract subtitles with a minimal command This change makes the README more beginner-friendly without changing existing functionality or behavior. ### Scope - Documentation only - No code changes - No behavior or build impact ### Notes This follows mentor feedback regarding: - avoiding duplicated content - maintaining logical README flow - keeping the change focused and minimal --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia commented

2026-01-29 17:24:24 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/CCExtractor/ccextractor/pull/2068
Author: @pranavshar223
Created: 1/27/2026
Status: ❌ Closed

Base: master ← Head: docs/readme-quick-start

📝 Commits (1)

9031e02 docs(readme): add Quick Start section and improve structure

📊 Changes

1 file changed (+35 additions, -11 deletions)

View changed files

📝 README.md (+35 -11)

📄 Description

In raising this pull request, I confirm the following (please check boxes):

I have read and understood the contributors guide.
I have checked that another pull request for this purpose does not exist.
I have considered, and confirmed that this submission will be valuable to others.
I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
I give this submission freely, and claim no ownership to its content.
I have mentioned this change in the changelog.

My familiarity with the project is as follows (check one):

I have never used CCExtractor.
I have used CCExtractor just a couple of times.
I absolutely love CCExtractor, but have not contributed previously.
I am an active contributor to CCExtractor.

Summary

This PR improves the README by adding a clear Quick Start section and improving the overall document flow, while avoiding duplication.

What was changed

Added a Quick Start section near the top of the README
Included basic installation guidance and a minimal usage example
Moved the Quick Start before the Installation section for better onboarding
Removed duplicated usage instructions to avoid redundancy
Improved repository link formatting for clarity and consistency

Why this change

New users often want a fast way to:

understand what CCExtractor does
install it quickly
extract subtitles with a minimal command

This change makes the README more beginner-friendly without changing existing functionality or behavior.

Scope

Documentation only
No code changes
No behavior or build impact

Notes

This follows mentor feedback regarding:

avoiding duplicated content
maintaining logical README flow
keeping the change focused and minimal

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

claunia added the pull-request label 2026-01-29 17:24:24 +00:00

claunia closed this issue

2026-01-29 17:24:25 +00:00

[PR #2068] [CLOSED] docs: add Quick Start section and improve structure #2879