Adding More installation Instructions to the docs and added supported Platforms in the readme (#432)
parent
590f4a341c
commit
f27f600661
12
README.md
12
README.md
|
@ -42,6 +42,14 @@ Yeah. Me too! That's why this tool exists.
|
|||
- Download using external downloader ([aria2](https://aria2.github.io/) recommended).
|
||||
- Configurable using `config.json`. See [documentation](https://anime-downlader.readthedocs.io/en/latest/usage/config.html).
|
||||
|
||||
## Supported Operating Systems:
|
||||
- Windows
|
||||
- Mac OS
|
||||
- Linux
|
||||
- Android
|
||||
- iOS (requires Jailbreak and some tinkering)
|
||||
* Instructions for Mobile Operating Systems can be found in the [Installation Documentation Page](https://anime-downlader.readthedocs.io/en/latest/usage/installation.html)
|
||||
|
||||
## Supported Sites
|
||||
**Details about the sites can be found in [FAQ](https://github.com/vn-ki/anime-downloader/wiki/FAQ)**
|
||||
- Anistream
|
||||
|
@ -76,6 +84,10 @@ Yeah. Me too! That's why this tool exists.
|
|||
- Kissanime - requires Selenium
|
||||
- Kisscartoon - requires Selenium
|
||||
|
||||
Sites That require Selenium **DO NOT** and **WILL NOT** work on mobile operating systems
|
||||
|
||||
Twist.moe **DOES NOT** work and **WILL NOT** work on iOS, a Python Module that is required for twist.moe is not supported on iOS and cannot be installed
|
||||
|
||||
## Installation
|
||||
|
||||
[**Installation instructions***](https://anime-downlader.readthedocs.io/en/latest/usage/installation.html)
|
||||
|
|
|
@ -5,6 +5,8 @@ Installation
|
|||
The following are extended installation instructions for Windows and
|
||||
Linux users. (For windows choco users, scroll to last)
|
||||
|
||||
Installation Instructions for *Mobile operating systems* are at the bottom, the 2 OS's explained are Android and iOS
|
||||
|
||||
Windows
|
||||
~~~~~~~
|
||||
|
||||
|
@ -81,3 +83,80 @@ all the following ``pip`` with ``pip3``.
|
|||
.. _python3: https://chocolatey.org/packages/python3
|
||||
.. _aria2: https://chocolatey.org/packages/aria2
|
||||
.. _mpv: https://chocolatey.org/packages/mpv
|
||||
|
||||
Android
|
||||
~~~~~~~
|
||||
|
||||
This does not require a rooted device to work
|
||||
|
||||
- Install Termux or similar Terminal Emulator
|
||||
|
||||
- Install Aria2c via the following command if using Termux ::
|
||||
|
||||
pkg install aria2c
|
||||
|
||||
- Install Python via the following command if using Termux ::
|
||||
|
||||
pkg install python
|
||||
|
||||
- Install git via the following command if using Termux ::
|
||||
|
||||
pkg install git
|
||||
|
||||
- Install Anime-Downloader via the following command after python and git are installed ::
|
||||
|
||||
pip3 install -U git+https://github.com/vn-ki/anime-downloader.git
|
||||
|
||||
- Enjoy, The normal commands should work the same as on the computer
|
||||
|
||||
iOS (Jailbreak Required)
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want this project to work on an iOS Device, you will need a jailbroken iPhone. visit r/jailbreak on reddit for the latest jailbreak news and information.
|
||||
|
||||
If you already happen to be jailbroken, then great! you are all set to go!
|
||||
|
||||
Tinkering May be Required
|
||||
|
||||
- Install the following packages from the mcapollo repo (https://mcapollo.github.io/Public/) using your favorite package manager ::
|
||||
|
||||
Aria2, Python@3.7, git, nano (for File editing), A Terminal Emulator (I recommend NewTerm because it has navigation keys)
|
||||
|
||||
- Open your Terminal Emulator and type in the following command ::
|
||||
|
||||
python3 -m ensurepip
|
||||
|
||||
- That should set up pip and setuptools
|
||||
|
||||
- Next you want to install Anime-Downloader
|
||||
- To Install Anime-Downloader before the PR which moves an unsupported module into extras follow along, if not, skip to where it has continue in parentheses
|
||||
|
||||
- First you want to clone the repository via this command ::
|
||||
|
||||
git clone https://github.com/vn-ki/anime-downloader.git
|
||||
|
||||
- next you want change your directory into the cloned repo. To do so, use the following command (it is case sensitive) ::
|
||||
|
||||
cd anime-downloader
|
||||
|
||||
- next you want to type in this command to start editing the file ::
|
||||
|
||||
nano setup.py
|
||||
|
||||
- use the arrow keys to navigate to the line that says ::
|
||||
|
||||
'pycryptodome>=3.8.2',
|
||||
|
||||
- And Delete that line so it looks like this
|
||||
|
||||
::image: https://i.imgur.com/0fRiNP6.png
|
||||
|
||||
- press the ctrl button then the letter "o", press enter, then press the ctrl button again, then press the letter "X"
|
||||
|
||||
- it should exit you back to the command line
|
||||
|
||||
- **(continue)** type the following command to install the project ::
|
||||
|
||||
python3 setup.py install
|
||||
|
||||
- let it run through, then the program should work as it does on the computer
|
||||
|
|
Loading…
Reference in New Issue