From 6b6db371851e69621cdbdb35dd15fa9aea7897a9 Mon Sep 17 00:00:00 2001 From: Ali Date: Tue, 23 Apr 2019 13:29:58 +0300 Subject: [PATCH] Minor corrections --- README.md | 19 +++++++++---------- docs/COMMAND_LINE_ARGUMENTS.md | 4 ++-- ...ROM_SOURCE.md => INTERPRET_FROM_SOURCE.md} | 8 ++++---- 3 files changed, 15 insertions(+), 16 deletions(-) rename docs/{COMPILE_FROM_SOURCE.md => INTERPRET_FROM_SOURCE.md} (88%) diff --git a/README.md b/README.md index 2d44c9f..0a8c42a 100644 --- a/README.md +++ b/README.md @@ -15,20 +15,19 @@ Downloads media from reddit posts. Made by [u/aliparlakci](https://reddit.com/u/ ## Installation -You can use it either as a Python script or `bulk-downloader-for-reddit.exe` file. +You can use it either as a *Python script* or `bulk-downloader-for-reddit.exe` file. + +### Executables + +For Windows and Linux, [download the latest release, here](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest). ### Python script * Download this repository ([latest zip](https://github.com/aliparlakci/bulk-downloader-for-reddit/archive/master.zip) or `git clone git@github.com:aliparlakci/bulk-downloader-for-reddit.git`). * Enter its folder. -* Run `python ./script.py` from the command-line (MacOSX or Linux command line; it may work with Anaconda prompt). +* Run `python ./script.py` from the command-line (Windows, MacOSX or Linux command line; it may work with Anaconda prompt) See [here](docs/INTERPRET_FROM_SOURCE.md#finding-the-correct-keyword-for-python) if you are having trouble. -It uses Python 3.6 and above. It won't work with Python 3.5 or any Python 2.x. If you have a trouble setting it up, see [here](docs/COMPILE_FROM_SOURCE.md). - - -### Executable - -For Windows, [download the latest release](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest). +It uses Python 3.6 and above. It won't work with Python 3.5 or any Python 2.x. If you have a trouble setting it up, see [here](docs/INTERPRET_FROM_SOURCE.md). ### Setting up the script @@ -42,9 +41,9 @@ When you run it for the first time, it will automatically create `config.json` f ## Running -You can run it it an interactive mode, or using [command-line arguments](docs/COMMAND_LINE_ARGUMENTS.md) (also aviable via `python ./script.py --help` or `bulk-downloader-for-reddit.exe --help`). +You can run it it an interactive mode, or using [command-line arguments](docs/COMMAND_LINE_ARGUMENTS.md) (also available via `python ./script.py --help` or `bulk-downloader-for-reddit.exe --help`). -To run the interactive mode, simply use `python ./script.py` or `bulk-downloader-for-reddit.exe` without any commands +To run the interactive mode, simply use `python ./script.py` or double click on `bulk-downloader-for-reddit.exe` without any extra commands. ### Example for an interactive script diff --git a/docs/COMMAND_LINE_ARGUMENTS.md b/docs/COMMAND_LINE_ARGUMENTS.md index 8b16acf..3e6c8f3 100644 --- a/docs/COMMAND_LINE_ARGUMENTS.md +++ b/docs/COMMAND_LINE_ARGUMENTS.md @@ -1,6 +1,6 @@ # Using command-line arguments -See **[compiling from source](COMPILE_FROM_SOURCE.md)** page first unless you are using an executable file. If you are using an executable file, see [using terminal](COMPILE_FROM_SOURCE.md#using-terminal) and come back. +See **[compiling from source](INTERPRET_FROM_SOURCE.md)** page first unless you are using an executable file. If you are using an executable file, see [using terminal](INTERPRET_FROM_SOURCE.md#using-terminal) and come back. ***Use*** `.\bulk-downloader-for-reddit.exe` ***or*** `./bulk-downloader-for-reddit` ***if you are using the executable***. ```console @@ -98,4 +98,4 @@ python script.py --directory C:\\NEW_FOLDER\\ANOTHER_FOLDER --log UNNAMED_FOLDER # FAQ ## I can't startup the script no matter what. -See **[finding the correct keyword for Python](COMPILE_FROM_SOURCE.md#finding-the-correct-keyword-for-python)** +See **[finding the correct keyword for Python](INTERPRET_FROM_SOURCE.md#finding-the-correct-keyword-for-python)** diff --git a/docs/COMPILE_FROM_SOURCE.md b/docs/INTERPRET_FROM_SOURCE.md similarity index 88% rename from docs/COMPILE_FROM_SOURCE.md rename to docs/INTERPRET_FROM_SOURCE.md index bb310f2..1814048 100644 --- a/docs/COMPILE_FROM_SOURCE.md +++ b/docs/INTERPRET_FROM_SOURCE.md @@ -1,4 +1,4 @@ -# Compiling from source code +# Interpret from source code ## Requirements ### Python 3 Interpreter - This program is designed to work best on **Python 3.6.5** and this version of Python 3 is suggested. See if it is already installed, [here](#finding-the-correct-keyword-for-python). @@ -6,11 +6,11 @@ ## Using terminal ### To open it... -- **On Windows**: Press **Shift+Right Click**, select **Open Powershell window here** or **Open Command Prompt window here** +- **on Windows**: Press **Shift+Right Click**, select **Open Powershell window here** or **Open Command Prompt window here** -- **On Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T**. +- **on Linux**: Right-click in a folder and select **Open Terminal** or press **Ctrl+Alt+T**. -- **On MacOS**: Look for an app called **Terminal**. +- **on MacOS**: Look for an app called **Terminal**. ### Navigating to the directory where script is downloaded Go inside the folder where script.py is located. If you are not familiar with changing directories on command-prompt and terminal read *Changing Directories* in [this article](https://lifehacker.com/5633909/who-needs-a-mouse-learn-to-use-the-command-line-for-almost-anything)