Restore README.md without instructions to install from PyPI

This commit is contained in:
Linus Groh
2018-04-17 17:16:10 +02:00
parent 2d2f5aa40c
commit 8b58230438

39
README.md Executable file → Normal file
View File

@@ -4,7 +4,7 @@
[![Coverage Status](https://codecov.io/gh/ritiek/spotify-downloader/branch/master/graph/badge.svg)](https://codecov.io/gh/ritiek/spotify-downloader) [![Coverage Status](https://codecov.io/gh/ritiek/spotify-downloader/branch/master/graph/badge.svg)](https://codecov.io/gh/ritiek/spotify-downloader)
[![Docker Build Status](https://img.shields.io/docker/build/ritiek/spotify-downloader.svg)](https://hub.docker.com/r/ritiek/spotify-downloader) [![Docker Build Status](https://img.shields.io/docker/build/ritiek/spotify-downloader.svg)](https://hub.docker.com/r/ritiek/spotify-downloader)
- Downloads songs from YouTube in an MP3 format by using Spotify's HTTP link. - Downloads songs from YouTube in an MP3 format by using Spotify's HTTP link.
- Can also download a song by entering its artist and song name (in case if you don't have the Spotify's HTTP link for some song). - Can also download a song by entering its artist and song name (in case if you don't have the Spotify's HTTP link for some song).
@@ -38,31 +38,26 @@ If you need to use Python 2 though, check out the (old) `python2` branch.
since they were not of much use and created unnecessary clutter. since they were not of much use and created unnecessary clutter.
You can still get them back by using `old` branch though. You can still get them back by using `old` branch though.
### Debian-like GNU/Linux & macOS ### Debian, Ubuntu, Linux & Mac
``` ```
$ pip install spotify-downloader $ cd
$ git clone https://github.com/ritiek/spotify-downloader
$ cd spotify-downloader
$ pip install -U -r requirements.txt
``` ```
**Important:** if you have installed both Python 2 and 3, the `pip` command **Important:** if you have installed both Python 2 and 3, the `pip` command
could invoke an installation for Python 2. To see which Python version `pip` could invoke an installation for Python 2. To see which Python version `pip`
refers to, try `$ pip -V`. If it turns out `pip` is your Python 2 pip, try refers to, try `$ pip -V`. If it turns out `pip` is your Python 2 pip, try
`$ pip3 install spotify-downloader` instead. `$ pip3 install -U -r requirements.txt` instead.
You'll also need to install FFmpeg for conversion You'll also need to install FFmpeg for conversion
(use `--avconv` if you'd like to use that instead): (use `--avconv` if you'd like to use that instead):
GNU/Linux: Linux: `$ sudo apt-get install ffmpeg`
``` Mac: `$ brew install ffmpeg --with-libmp3lame --with-libass --with-opus --with-fdk-aac`
$ sudo apt-get install ffmpeg
```
macOS:
```
$ brew install ffmpeg --with-libmp3lame --with-libass --with-opus --with-fdk-aac
```
If it does not install correctly, you may have to build it from source. If it does not install correctly, you may have to build it from source.
For more info see https://trac.ffmpeg.org/wiki/CompilationGuide. For more info see https://trac.ffmpeg.org/wiki/CompilationGuide.
@@ -70,21 +65,18 @@ For more info see https://trac.ffmpeg.org/wiki/CompilationGuide.
### Windows ### Windows
Assuming you have Python 3 Assuming you have Python 3
([preferably v3.6 or above to stay away from Unicode errors](https://stackoverflow.com/questions/30539882/whats-the-deal-with-python-3-4-unicode-different-languages-and-windows)) and pip already installed and in PATH. ([preferably v3.6 or above to stay away from Unicode errors](https://stackoverflow.com/questions/30539882/whats-the-deal-with-python-3-4-unicode-different-languages-and-windows)) already installed and in PATH.
- Download and extract the [zip file](https://github.com/ritiek/spotify-downloader/archive/master.zip)
from master branch.
- Download FFmpeg for Windows from [here](http://ffmpeg.zeranoe.com/builds/). - Download FFmpeg for Windows from [here](http://ffmpeg.zeranoe.com/builds/).
Copy `ffmpeg.exe` from `ffmpeg-xxx-winxx-static\bin\ffmpeg.exe` to PATH Copy `ffmpeg.exe` from `ffmpeg-xxx-winxx-static\bin\ffmpeg.exe` to PATH
(usually C:\Windows\System32\) or just place it in the root directory extracted (usually C:\Windows\System32\) or just place it in the root directory extracted
from the above step. from the above step.
- Open `cmd` and type `pip install spotify-downloader`. - Open `cmd` and type `$ pip install -U -r requirements.txt` to install dependencies.
The same note about `pip` as for GNU/Linux and macOS applies. The same note about `pip` as for Debian, Ubuntu, Linux & Mac applies.
### From GitHub releases
- Download and extract the [latest](https://github.com/ritiek/spotify-downloader/releases/latest) or a [specific](https://github.com/ritiek/spotify-downloader/releases) release archive file.
- `cd` into the directory and `pip install -e .`
## Instructions for Downloading Songs ## Instructions for Downloading Songs
@@ -344,3 +336,4 @@ Please support the artists by buying their music.
## License ## License
[![License](https://img.shields.io/github/license/ritiek/spotify-downloader.svg)](https://github.com/ritiek/spotify-downloader/blob/master/LICENSE) [![License](https://img.shields.io/github/license/ritiek/spotify-downloader.svg)](https://github.com/ritiek/spotify-downloader/blob/master/LICENSE)