From af7d3d9151e481e2fb11d36d232d8bb5c2f73ee2 Mon Sep 17 00:00:00 2001 From: Ali Parlakci Date: Sun, 27 Jan 2019 16:32:00 +0300 Subject: [PATCH] Moved FAQ --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0841a14..e16690b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Bulk Downloader for Reddit Downloads media from reddit posts. -## [Download the latest release](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest) +## [Download the latest release here](https://github.com/aliparlakci/bulk-downloader-for-reddit/releases/latest) ## What it can do - Can get posts from: frontpage, subreddits, multireddits, redditor's submissions, upvoted and saved posts; search results or just plain reddit links @@ -13,8 +13,8 @@ Downloads media from reddit posts. - Saves a reusable copy of posts' details that are found so that they can be re-downloaded again - Logs failed ones in a file to so that you can try to download them later -## **[Compiling it from source code](docs/COMPILE_FROM_SOURCE.md)** -*\* MacOS users have to use this option.* +## **Compiling it from source code** +MacOS users have to use this option. See *[here](docs/COMPILE_FROM_SOURCE.md)* ## Additional options Script also accepts additional options via command-line arguments. Get further information from **[`--help`](docs/COMMAND_LINE_ARGUMENTS.md)** @@ -24,6 +24,30 @@ You need to create an imgur developer app in order API to work. Go to https://ap It should redirect you to a page where it shows your **imgur_client_id** and **imgur_client_secret**. -## [FAQ](docs/FAQ.md) +## FAQ +### How can I change my credentials? +- All of the user data is held in **config.json** file which is in a folder named "Bulk Downloader for Reddit" in your **Home** directory. You can edit + them, there. -## [Changes on *master*](docs/CHANGELOG.md) \ No newline at end of file +### What do the dots resemble when getting posts? +- Each dot means that 100 posts are scanned. + +### Getting posts takes too long. +- You can press *Ctrl+C* to interrupt it and start downloading. + +### How are the filenames formatted? +- **Self posts** and **images** that do not belong to an album and **album folders** are formatted as: + `[SUBMITTER NAME]_[POST TITLE]_[REDDIT ID]` + You can use *reddit id* to go to post's reddit page by going to link reddit.com/[REDDIT ID] + +- An **image in an album** is formatted as: + `[ITEM NUMBER]_[IMAGE TITLE]_[IMGUR ID]` + Similarly, you can use *imgur id* to go to image's imgur page by going to link imgur.com/[IMGUR ID]. + +### How do I open self post files? +- Self posts are held at reddit as styled with markdown. So, the script downloads them as they are in order not to lose their stylings. + However, there is a [great Chrome extension](https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk) for viewing Markdown files with its styling. Install it and open the files with [Chrome](https://www.google.com/intl/tr/chrome/). + + However, they are basically text files. You can also view them with any text editor such as Notepad on Windows, gedit on Linux or Text Editor on MacOS + +## [See the changes on *master* here](docs/CHANGELOG.md) \ No newline at end of file