Wrote more of the readme and made a requirments.txt

This commit is contained in:
Kepoor Hampond 2016-07-07 22:59:12 -07:00
parent 881c84cfb7
commit e22926522a
2 changed files with 36 additions and 3 deletions

View file

@ -1,6 +1,36 @@
# The Ingenious Redistribution System (IRS) # The Ingenious Redistribution System (IRS)
_**Downloads or streams media from the name of the song / album / movie / tv-show.**_ Downloads or streams media from the name of the song / album / movie / tv-show that you requested.
### Dependencies
First, acutally install python and pip:
- To install python3 and `pip` for Ubuntu run this command:
```bash
$ sudo apt-get install python3 python3-pip
```
- For Windows follow [this](http://www.howtogeek.com/197947/how-to-install-python-on-windows/) guide to install python (remember to install ~v3.4), and [this](https://pip.pypa.io/en/latest/installing/) guide to install `pip`.
- For OSX follow [this](http://docs.python-guide.org/en/latest/starting/install/osx/) guide that goes through python and `pip`. Also, remember to install ~v3.4.
Then install `requirements.txt` from the repository:
```bash
python install -r requirements.txt
```
There are some more external command-line programs that are essential to movies, tv-shows, and streaming:
- rTorrent: [Windows](https://rtwi.jmk.hu/wiki/rTorrentOnWindows), [OSX](http://macappstore.org/rtorrent/), Ubuntu: `sudo apt-get install rtorrent`
- mpv: https://mpv.io/installation/
- Peerflix:
- Windows: follow [this](http://blog.teamtreehouse.com/install-node-js-npm-windows) guide to install npm:
```bash
$ npm install -g peerflix
```
- OSX: Same as Windows, except follow [this](http://blog.teamtreehouse.com/install-node-js-npm-mac) guide.
- Ubuntu: Again, the same, only follow [this](http://blog.teamtreehouse.com/install-node-js-npm-linux) guide instead.
And that should be it!
### Overview
Currently the system can stream or download the following: Currently the system can stream or download the following:
- Specific songs. - Specific songs.
@ -17,5 +47,3 @@ When downloading music, the system will fill out the specific meta-data so that
- Tracknumber.* - Tracknumber.*
<sup>\* Album art is slightly buggy, and tracknumber only works when downloading complete album.<sup> <sup>\* Album art is slightly buggy, and tracknumber only works when downloading complete album.<sup>
### NOTE THAT THE README IS CURRENTLY BEING WORKED ON.

5
requirements.txt Normal file
View file

@ -0,0 +1,5 @@
mutagen == 1.31
requests == 2.10.0
beautifulsoup4 == 4.4.1
termcolor == 1.1.0
youtube_dl == 2016.7.7