rnhmjoj/pirate-get
1
0
Fork 0
mirror of https://github.com/vikstrous/pirate-get synced 2025-01-10 10:04:21 +01:00
Code Issues Releases Wiki Activity

Fixes #17 - Updated docs with config file info

Browse Source 
sorry for the stupid commit before
This commit is contained in:
Brad Horrocks 2014-06-05 20:41:44 -06:00
parent c5162b76ae
commit 6c3b7c1dfb
1 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1,12 +1,11 @@
pirate-get # pirate-get
---
pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly. pirate-get is a convenient command line tool (inspired by APT) to speed up your trip to the Pirate Bay and get your completely legal torrents more quickly.
Tested on Arch Linux mostly. It should work on any other Linux too. Let me know if it doesn't. Also tested on OSX (whatever the latest one is - I don't know; I don't use non-free operating systems.) --local option hasn't been tested recently. Tested on Arch Linux mostly. It should work on any other Linux too. Let me know if it doesn't. Also tested on OSX (whatever the latest one is - I don't know; I don't use non-free operating systems.) --local option hasn't been tested recently.
Installation
--- ## Installation
Make sure you have python 2 installed. Make sure you have python 2 installed.
@ -15,8 +14,7 @@ Run install.sh
If you're using Arch Linux there's a package avalaible at the AUR: If you're using Arch Linux there's a package avalaible at the AUR:
https://aur.archlinux.org/packages/pirate-get-git/ https://aur.archlinux.org/packages/pirate-get-git/
Usage ## Usage
---
``` ```
usage: pirate-get.py [-h] [-t] [--custom COMMAND] [--local DATABASE] usage: pirate-get.py [-h] [-t] [--custom COMMAND] [--local DATABASE]
@ -38,6 +36,24 @@ optional arguments:
--color use colored output --color use colored output
``` ```
## Configuration file
pirate-get will check to see if `$HOME/.config/pirate-get/pirate.cfg` exists. If it does it will use it as its default configuration settings.
### SaveToFile
**Currently this is the only way to save magnet urls to a file**
A config file would look something like:
```INI
[SaveToFile]
enabled = true
directory = ~/Dropbox/pirate-get/
```
## Notes
If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently): If you want to use a local copy of the Pirate Bay database download a copy here (or wherever the latest version is currently):
http://thepiratebay.se/torrent/8156416 http://thepiratebay.se/torrent/8156416