Skip to content

Commit

Permalink
ReadMe fixed
Browse files Browse the repository at this point in the history
Corrected grammatical errors, typos and updated readme for better
understanding.
  • Loading branch information
Xonshiz committed Mar 27, 2017
1 parent 8833c99 commit 98b7649
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 14 deletions.
32 changes: 25 additions & 7 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Anime-DL | [![Build Status](https://travis-ci.org/Xonshiz/anime-dl.svg?branch=master)](https://travis-ci.org/Xonshiz/anime-dl) [![Documentation Status](https://readthedocs.org/projects/anime-dl/badge/?version=latest)](http://anime-dl.readthedocs.io/en/latest/?badge=latest) | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/xonshiz)

Anime-dl is a Command-line program to download anime from CrunchyRoll and Funimation. This script needs you to have a premium subscription to the listed services. If you don't have a subscription, this script is pretty much usless for you.
Anime-dl is a Command-line program to download anime from CrunchyRoll and Funimation. This script needs you to have a premium subscription for the listed services. If you don't have a subscription, this script is pretty much usless for you.

> Downloading and distributing this content may be illegal.This script was written for education purposes purely and you are responsible for its use.
Expand Down Expand Up @@ -34,9 +34,13 @@ You can check the list of supported websites [**`HERE`**](https://github.com/Xon
This script can run on multiple Operating Systems. So, if you're using the `python` script instead of the `windows binary` of this script, then you'll need to get things ready first. Since this script doesn't rely on a lot of external dependencies, you just need to grab a few things, same for all operating systems.

1.) Make sure you have Python installed and is present in your system's path.

2.) Grab [FFmpeg from this link.](https://ffmpeg.org/download.html)

3.) Install FFmpeg and place it in the directory of this script, or put FFmpeg in your system's path.

4.) Browse to the directory of this script and open command prompt/shell in that directory and run this command :

```
python pip install -r requirements.txt
```
Expand All @@ -45,16 +49,18 @@ python pip install -r requirements.txt
After installing and setting up all the dependencies in your Operating System, you're good to go and use this script.
The instructions for all the OS would remain same. Download [`THIS REPOSITORY`](https://github.com/Xonshiz/anime-dl/archive/master.zip) and put it somewhere in your system. Move over the `anime_dl` folder.

**Windows users**, it's better to not place it places where it requires administrator privileges. Good example would be `C:\Windows`. This goes for both, the Python script and the windows binary file (.exe).
**Windows users**, it's better to not place it places where it requires administrator privileges. Good example of such place would be `C:\Windows`. This goes for both, the Python script and the windows binary file (.exe).

**Linux/Debian** users make sure that this script is executable.just run this command, if you run into problem(s) :
**Linux/Debian** users make sure that this script is executable.Just run this command, if you run into problem(s) :

`chmod +x anime-dl.py`

`chmod +x __main__.py`

and then, execute with this :

`./anime-dl.py`

`./__main__.py`

## Python Support
Expand All @@ -63,7 +69,7 @@ This script supports only Pythom 3 currently..
## Windows Binary
It is recommended that windows users use this binary to save both, your head and time from installing all the dependencies.

You need to download [FFmpeg](https://ffmpeg.org/download.html) and keep it in the same directory as that of this windows binary file or you need to have PhantomJS in your path.
You need to download [FFmpeg](https://ffmpeg.org/download.html) and keep it in the same directory as that of this windows binary file.

If you already have it, then you can download this binary and start using the script right off the bat :
* `Binary (x86)` : [Click Here](https://github.com/Xonshiz/anime-dl/releases/latest)
Expand All @@ -75,8 +81,8 @@ Currently, the script supports these arguments :
-h, --help Prints the basic help menu of the script and exits.
-i,--input Defines the input link to the anime.
-V,--version Prints the VERSION and exits.
-u,--username Indicates username for a website.
-p,--password Indicates password for a website.
-u,--username Indicates username for a website. [REQUIRED]
-p,--password Indicates password for a website. [REQUIRED]
-r,--resolution Indicates the desired resolution. (default = 720p)
-l,--language Selects the language for the show. (default = Japanese) [Langs = english, dub, sub, Japanese, eng]
```
Expand Down Expand Up @@ -123,6 +129,8 @@ This is a very basic and small sript, so at the moment it only have a few featur
* Downloads a Single episode along with all the available subtitles for that episode.
* Downloads and puts them all in a directory named "Output".
* Skip if the file has already been downloaded.
* Downloads all the episodes for a show available on Crunchyroll.
* Gives choice for downloading subs or dubs of a series available on Crunchyroll.

## Changelog
You can check the changelog [**`HERE`**](https://github.com/Xonshiz/anime-dl/blob/master/Changelog.md).
Expand All @@ -131,7 +139,17 @@ You can check the changelog [**`HERE`**](https://github.com/Xonshiz/anime-dl/blo
If your're planning to open an issue for the script or ask for a new feature or anything that requires opening an Issue, then please do keep these things in mind.

### Reporting Issues
Please do make sure that you read and follow this :
PLEASE RUN THIS SCRIPT IN A COMMAND LINE (as mentioned in the Usage section) AND DON'T SAY THAT `THE SCRIPT CLOSED TOO QUICK, I COULDN'T SEE`.

If you're here to make suggestions, please follow the basic syntax to post a request :

**Subject** : Error That You Get.

**Command Line Arguments You Gave** : The whole command that you gave to execute/run this script.

**Long Explanation** : Describe in details what you saw, what should've happened and what actually happened.

This should be enough, but it'll be great if you can add more ;)

### Suggesting A Feature
If you're here to make suggestions, please follow the basic syntax to post a request :
Expand Down
32 changes: 25 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Anime-DL | [![Build Status](https://travis-ci.org/Xonshiz/anime-dl.svg?branch=master)](https://travis-ci.org/Xonshiz/anime-dl) [![Documentation Status](https://readthedocs.org/projects/anime-dl/badge/?version=latest)](http://anime-dl.readthedocs.io/en/latest/?badge=latest) | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/xonshiz)

Anime-dl is a Command-line program to download anime from CrunchyRoll and Funimation. This script needs you to have a premium subscription to the listed services. If you don't have a subscription, this script is pretty much usless for you.
Anime-dl is a Command-line program to download anime from CrunchyRoll and Funimation. This script needs you to have a premium subscription for the listed services. If you don't have a subscription, this script is pretty much usless for you.

> Downloading and distributing this content may be illegal.This script was written for education purposes purely and you are responsible for its use.
Expand Down Expand Up @@ -34,9 +34,13 @@ You can check the list of supported websites [**`HERE`**](https://github.com/Xon
This script can run on multiple Operating Systems. So, if you're using the `python` script instead of the `windows binary` of this script, then you'll need to get things ready first. Since this script doesn't rely on a lot of external dependencies, you just need to grab a few things, same for all operating systems.

1.) Make sure you have Python installed and is present in your system's path.

2.) Grab [FFmpeg from this link.](https://ffmpeg.org/download.html)

3.) Install FFmpeg and place it in the directory of this script, or put FFmpeg in your system's path.

4.) Browse to the directory of this script and open command prompt/shell in that directory and run this command :

```
python pip install -r requirements.txt
```
Expand All @@ -45,16 +49,18 @@ python pip install -r requirements.txt
After installing and setting up all the dependencies in your Operating System, you're good to go and use this script.
The instructions for all the OS would remain same. Download [`THIS REPOSITORY`](https://github.com/Xonshiz/anime-dl/archive/master.zip) and put it somewhere in your system. Move over the `anime_dl` folder.

**Windows users**, it's better to not place it places where it requires administrator privileges. Good example would be `C:\Windows`. This goes for both, the Python script and the windows binary file (.exe).
**Windows users**, it's better to not place it places where it requires administrator privileges. Good example of such place would be `C:\Windows`. This goes for both, the Python script and the windows binary file (.exe).

**Linux/Debian** users make sure that this script is executable.just run this command, if you run into problem(s) :
**Linux/Debian** users make sure that this script is executable.Just run this command, if you run into problem(s) :

`chmod +x anime-dl.py`

`chmod +x __main__.py`

and then, execute with this :

`./anime-dl.py`

`./__main__.py`

## Python Support
Expand All @@ -63,7 +69,7 @@ This script supports only Pythom 3 currently..
## Windows Binary
It is recommended that windows users use this binary to save both, your head and time from installing all the dependencies.

You need to download [FFmpeg](https://ffmpeg.org/download.html) and keep it in the same directory as that of this windows binary file or you need to have PhantomJS in your path.
You need to download [FFmpeg](https://ffmpeg.org/download.html) and keep it in the same directory as that of this windows binary file.

If you already have it, then you can download this binary and start using the script right off the bat :
* `Binary (x86)` : [Click Here](https://github.com/Xonshiz/anime-dl/releases/latest)
Expand All @@ -75,8 +81,8 @@ Currently, the script supports these arguments :
-h, --help Prints the basic help menu of the script and exits.
-i,--input Defines the input link to the anime.
-V,--version Prints the VERSION and exits.
-u,--username Indicates username for a website.
-p,--password Indicates password for a website.
-u,--username Indicates username for a website. [REQUIRED]
-p,--password Indicates password for a website. [REQUIRED]
-r,--resolution Indicates the desired resolution. (default = 720p)
-l,--language Selects the language for the show. (default = Japanese) [Langs = english, dub, sub, Japanese, eng]
```
Expand Down Expand Up @@ -123,6 +129,8 @@ This is a very basic and small sript, so at the moment it only have a few featur
* Downloads a Single episode along with all the available subtitles for that episode.
* Downloads and puts them all in a directory named "Output".
* Skip if the file has already been downloaded.
* Downloads all the episodes for a show available on Crunchyroll.
* Gives choice for downloading subs or dubs of a series available on Crunchyroll.

## Changelog
You can check the changelog [**`HERE`**](https://github.com/Xonshiz/anime-dl/blob/master/Changelog.md).
Expand All @@ -131,7 +139,17 @@ You can check the changelog [**`HERE`**](https://github.com/Xonshiz/anime-dl/blo
If your're planning to open an issue for the script or ask for a new feature or anything that requires opening an Issue, then please do keep these things in mind.

### Reporting Issues
Please do make sure that you read and follow this :
PLEASE RUN THIS SCRIPT IN A COMMAND LINE (as mentioned in the Usage section) AND DON'T SAY THAT `THE SCRIPT CLOSED TOO QUICK, I COULDN'T SEE`.

If you're here to make suggestions, please follow the basic syntax to post a request :

**Subject** : Error That You Get.

**Command Line Arguments You Gave** : The whole command that you gave to execute/run this script.

**Long Explanation** : Describe in details what you saw, what should've happened and what actually happened.

This should be enough, but it'll be great if you can add more ;)

### Suggesting A Feature
If you're here to make suggestions, please follow the basic syntax to post a request :
Expand Down

0 comments on commit 98b7649

Please sign in to comment.