rogs/subscleaner
rogs/subscleaner
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 11 Wiki Activity

Updated README

Browse Source
This commit is contained in:
Roger Gonzalez 2024-03-03 18:15:42 -03:00
parent 6ff7c9750a
commit c234fd9fde
Signed by: rogs
GPG Key ID: C7ECE9C6C36EC2E6
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -10,6 +10,16 @@ Subscleaner is a Python script that removes advertisements from subtitle files.
## Installation ## Installation
### Automatic installation
To install with `pip`:
``` sh
sudo pip install subscleaner
```
### Manual installation
To install Subscleaner, you'll need Python 3.9 or higher. It's recommended to use Poetry for managing the project dependencies. To install Subscleaner, you'll need Python 3.9 or higher. It's recommended to use Poetry for managing the project dependencies.
1. Clone the repository: 1. Clone the repository:
@ -32,7 +42,13 @@ poetry install
## Usage ## Usage
To use Subscleaner, you can pipe a list of subtitle filenames into the script: If you installed the package automatically, you can pipe a list of subtitle filenames into the script:
``` sh
find /your/media/location -name "*.srt" | subscleaner
```
If you installed the package manually:
``` sh ``` sh
find /your/media/location -name "*.srt" | poetry run subscleaner find /your/media/location -name "*.srt" | poetry run subscleaner
@ -50,7 +66,7 @@ Contributions are welcome! If you have any suggestions or improvements, feel fre
## License ## License
Subscleaner is licensed under the GNU General Public License v3.0 or later. See the LICENSE file for more details. Subscleaner is licensed under the GNU General Public License v3.0 or later. See the [LICENSE](https://gitlab.com/rogs/subscleaner/-/blob/master/LICENSE) file for more details.
## Acknowledgments ## Acknowledgments

2
pyproject.toml
View File

@ -1,6 +1,6 @@
[tool.poetry] [tool.poetry]
name = "subscleaner" name = "subscleaner"
version = "0.1.1" version = "0.1.2"
description = "Remove advertisements from subtitle files" description = "Remove advertisements from subtitle files"
authors = ["Roger Gonzalez <roger@rogs.me>"] authors = ["Roger Gonzalez <roger@rogs.me>"]
license = "GPL-3.0-or-later" license = "GPL-3.0-or-later"