Skip to content
This repository was archived by the owner on Jul 3, 2023. It is now read-only.

Commit 5af9147

Browse files
committed
Update README.md
1 parent 8070039 commit 5af9147

1 file changed

Lines changed: 53 additions & 14 deletions

File tree

README.md

Lines changed: 53 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,80 @@
1-
# Offline Sub Converter
2-
3-
Offline Sub Converter allows you to change subtitle formats using the command shell.
1+
<h1 align="center">Offline Sub Converter</h1>
2+
3+
<p align="center">The CLI script made with Python for easy conversion of subtitles files</p>
4+
5+
<p align="center">
6+
<a style="text-decoration:none" href="https://github.com/TheFifthLeaf/offline-sub-converter/releases">
7+
<img src="https://img.shields.io/github/v/release/TheFifthLeaf/offline-sub-converter?color=3C7DD9" alt="Releases">
8+
</a>
9+
<a style="text-decoration:none" href="https://www.python.org/downloads/">
10+
<img src="https://img.shields.io/badge/python-3.6%2B-3C7DD9" alt="Python Version">
11+
</a>
12+
<a style="text-decoration:none" href="https://choosealicense.com/licenses/gpl-3.0/">
13+
<img src="https://img.shields.io/badge/license-GPL%20V3-3C7DD9" alt="License GPLv3">
14+
</a>
15+
<a href="https://www.codefactor.io/repository/github/thefifthleaf/offline-sub-converter">
16+
<img src="https://img.shields.io/badge/codefactor-A%2B-3C7DD9" alt="CodeFactor" />
17+
</a>
18+
</p>
419

520
## Installation
621

7-
This program uses an external module:
22+
You will need an external module to use the .py script
823
- chardet
924

10-
You can install it with the command:
25+
You can install it throught the requirements file
1126

1227
```bash
1328
pip install -r requirements.txt
1429
```
1530

16-
If the installation fails due to lack of access rights, try this:
31+
If the installation fails due to lack of access rights, try this
1732

1833
```bash
1934
pip install --user -r requirements.txt
2035
```
2136

37+
**However, feel free to use the portable .exe file, which does not require additional installations.**
38+
2239
## Usage
2340

24-
To convert, type:
41+
To convert using .exe, please type:
42+
43+
```bash
44+
sub_converter.exe "path" format
45+
```
46+
47+
And using .py, type:
2548

2649
```bash
27-
python sub_converter.py "path" format_to
50+
python sub_converter.py "path" format
2851
```
2952

30-
path - Directory or single file to convert\
31-
format_to - Target format
53+
### Usage example
54+
55+
This will convert the specified file to SubRip format
56+
```bash
57+
sub_converter.exe "D:\Video\Se7en.sub" srt
58+
```
59+
This will convert all the subtitle files in the Video directory to MicroDVD format
60+
```bash
61+
sub_converter.exe "D:\Video" sub
62+
```
63+
This will convert all the subtitle files in the current folder to MPlayer2 format
64+
```bash
65+
sub_converter.exe "." mpl
66+
```
67+
This will display help information
68+
```bash
69+
sub_converter.exe -h
70+
```
3271

3372
## Supported formats
3473

35-
- SubRip (srt), .srt
36-
- MicroDVD (sub), .sub
37-
- MPlayer2 (mpl), .txt
38-
- TMPlayer (tmp), .txt
74+
- as **srt** - SubRip (.srt)
75+
- as **sub** - MicroDVD (.sub)
76+
- as **mpl** - MPlayer2 (.txt)
77+
- as **tmp** - TMPlayer (.txt)
3978

4079
## Contributing
4180

0 commit comments

Comments
 (0)