Commit 9eb0e9a

committed

Add readme and screenshots

1 parent d0a4f76 commit 9eb0e9aCopy full SHA for 9eb0e9a

File tree

+15

-1

lines changed

+15

-1

lines changed

Lines changed: 0 additions & 1 deletion

Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,15 @@`
	`1`	`+# Reddit Meme Scraper`
	`2`	`+`
	`3`	`+This script locates and downloads images from several subreddits (r/deepfriedmemes, r/surrealmemes, r/nukedmemes, r/bigbangedmemes, r/wackytictacs, r/bonehurtingjuice) into your local system.`
	`4`	`+`
	`5`	`+For the sake of simplicity (and so that your system doesn't get stuffed full of images), the download is limited to 25 (total) images per run.`
	`6`	+However, you are welcome to modify that limit to whatever amount you'd like or remove it altogether, but then make sure you update `sg.ProgressBar()` so it properly represents the download progress.
	`7`	`+`
	`8`	`+## Usage`
	`9`	`+`
	`10`	+Make sure you have installed the necessary packages listed in `requirements.txt`, then simply run `script.py`.
	`11`	`+You'll be greeted by a popup window asking where to download the images, after which the download will commence.`
	`12`	`+`
	`13`	`+## Screenshots`
	`14`	`+`
	`15`	`+Some screenshots showing how the script works:`