Skip to content

docs: improve README clarity and add quick start section #2021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mohithshuka wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −2
Open

docs: improve README clarity and add quick start section #2021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@

CCExtractor is a tool used to produce subtitles for TV recordings from almost anywhere in the world. We intend to keep up with all sources and formats.

Subtitles are important for many people. If you're learning a new language, subtitles are a great way to learn it from movies or TV shows. If you are hard of hearing, subtitles can help you better understand what's happening on the screen. We aim to make it easy to generate subtitles by using the command line tool or Windows GUI.
Subtitles are important for many people. If you're learning a new language, subtitles are great way to learn it from movies or TV shows. If you are hard of hearing, subtitles can help you better understand what's happening on the screen. We aim to make it easy to generate subtitles by using the command line tool or Windows GUI.

The official repository is [CCExtractor/ccextractor](https://github.com/CCExtractor/ccextractor), with `master` being the most stable branch.

The official repository is ([CCExtractor/ccextractor](https://github.com/CCExtractor/ccextractor)) and master being the most stable branch.

### **Features**

Expand All @@ -28,6 +29,13 @@ The core functionality is written in C. Other languages used include C++ and Pyt

Downloads for precompiled binaries and source code can be found [on our website](https://ccextractor.org/public/general/downloads/).

## Quick Start

After installing CCExtractor, you can extract subtitles using the following command:

```bash
ccextractor <input_video_file>


### Windows Package Managers

Expand Down