sselph
Better User Documentation
My readme is very terse. Adding better examples, etc would probably help users out.
@sselph Hi, I'm Andrea from Italy. I really appreciated your scraper! how to offer you a beer for your work? do you have a paypal account where to make a donation? Bye!
Thanks! I'm glad you like the script. I don't have an account to accept any donations, but If you are in a giving mood, you could donate to thegamesDB, EmulationStation, or RetroPie. I owe them a beer.
Ok, thanks! I'll do. Cheers, Andrea. Il 08/feb/2015 14:41 "Steven Selph" [email protected] ha scritto:
Thanks! I'm glad you like the script. I don't have an account to accept any donations, but If you are in a giving mood, you could donate to thegamesDB, EmulationStation, or RetroPie. I owe them a beer.
— Reply to this email directly or view it on GitHub https://github.com/sselph/scraper/issues/15#issuecomment-73411212.
@sselph Found this in github for Retropie-Setup. Felt it would be well suited as a main page for the wiki. I made several revisional changes to what was on their site to make this a bit more current.
https://github.com/sselph/scraper/wiki
@stevetb Its nice and all but the documentation in the retropie wiki is very specific to retropie (including the dialog menu etc) sselphs scraper can be used on windows and other systems with much more command line flags for more flexibility, perhaps those would be better highlighted in the official sselph scraper wiki for all its use cases rather than the interface specific to the retropie project, though I think it's a good idea to have a page specific to the implementation in RetroPie or at least a link to it.
@HerbFargus I have always assumed most, if not all, users are on RetroPie. Perhaps there is a parallel group out there using it for Windows / Linux actively, but I am not aware of any.
The Home Wiki page this replaced previously said "Home for SSELPH Scraper" so I believe my changes were value added for sure, even if RetroPie specific. The great thing about the Wiki Home page is you can make changes too, not just troll. So please add your referenced Windows and Linux sites to add visibility to their community.
Not trolling just being verbose. I meant no criticism, just sharing my opinion.
You're probably correct in That the majority of people who use sselphs scraper are using RetroPie but o guess I'm one of the few who also use it for windows and Linux.
But as this is the repository for the scraper itself rather than for RetroPie it makes sense to document all its use cases as long as they are clear. There is a certain irony to your criticism of my input seeing as I've written the majority of the retropie wiki along with the stuff you copied over to the home page of this wiki. ;)
BTW good work with all your no intro hashes
I'm happy to work on this wiki too when I find the time as long as I'm not stepping on any toes
Thanks for bringing this back up and taking some initiative to work on it. The scraper is also used by Recalbox, LaunchBox, EmulationStation standalone, and others. ~30% of the binary downloads are for windows.
I'll try and make some time to add in some use cases. There should be some better documentation on running the scraper from the command line for different use cases since there are so many flags it can be daunting to figure out the right combination to get the job done. But since RetroPie makes up a large portion of users, there definitely needs to be some RetroPie specific stuff. Like that it is likely already installed and the path information that needs to be set to have the same behavior as when running from the menu.
If anyone has something they think needs explaining how to do feel free to ping this issue or write up the use case in the wiki and I can fill in documentation on how to run the scraper to accomplish the goal. My use case was scrape 2 systems and all the defaults meet my needs(which is why they are the defaults) so ideas and experiences are welcome.
I've updated the wiki home page and its somewhat derived from the readme with a few enhancements and I've made sure to reference retropie and link it to the retropie Wiki page, feel free to add any improvements or changes
Thanks. I made a few changes to some of the links and wording. I also created a https://github.com/sselph/scraper/wiki/Using-your-own-images to talk about some of the ways to make the scraper use images the user supplied since it seems to come up a lot. I need to test them to make sure they actually work.
Appreciated. just as a reference I wrote a snippet on scraping your own images on the RetroPie wiki and I can confirm that one works as I wrote it as I tested it:
https://github.com/RetroPie/RetroPie-Setup/wiki/scraper#scraping-your-own-images
But it more or less looks like the same instructions that you wrote so probably should work