Scallywag-NG/README.md

48 lines
1.4 KiB
Markdown

# Scallywag-NG
A GTK3 torrent/magnet search application that automatically locates the PirateBay reverse proxies and allows users to search for and select items to open via your XDG default set torrent/magnet client.
## History
Scallywag-NG is a C port of the famous Python utility Scallywag, now with half the scally and three times the wag.
## Dependencies
### Fedora
```bash
sudo dnf install cmake gcc gtk3-devel libcurl-devel libxml2-devel glib2-devel
```
### Ubuntu / Debian
```bash
sudo apt install cmake gcc libgtk-3-dev libcurl4-openssl-dev libxml2-dev libglib2.0-dev
```
## Building
```bash
mkdir build
cd build
cmake ..
make
```
## Running
```bash
./scallywag
```
Configuration is stored in `~/.config/scallywag/config.ini` and is auto-created with defaults on first run.
## License
Copyright (C) SILO GROUP LLC
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.