diff --git a/README.md b/README.md index 60cb9c3..d9cb8be 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # RetroUFO -[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20windows-yellow.svg)](https://www.youtube.com/watch?v=NLGoKxh8Aq4) +[![Platform](https://img.shields.io/badge/platform-linux%20%7C%20macos-yellow.svg)](https://www.youtube.com/watch?v=NLGoKxh8Aq4) [![Python Version](https://img.shields.io/pypi/pyversions/Django.svg)](https://www.python.org/downloads/) [![License.](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT) A ~~messy~~ Python script that grabs the latest version of every libretro core from the [build bot](https://buildbot.libretro.com/). *** -### Usage +### Usage-CLI Just run the script with _Python 3_: @@ -21,6 +21,28 @@ If you are more of a advance user, and want to do things a bit more manually, yo python3 ./RetroUFO.py --help ``` +### Usage-GUI + +The GUI script uses [Qt for Python](https://wiki.qt.io/Qt_for_Python) ([PySide2](https://pypi.org/project/PySide2/)). So you can make sure you have that package installed by running: +```bash +pip3 install --user PySide2 +``` +After that you can just run the script like so: +```bash +python3 ./RetroUFO_GUI.py +``` + +You can then just click the `Grab Cores` button at the bottom and then you should be all set. + + + +If you would like to grab cores for a different platform or architecture you can override which supported cores it grabs. + + + +If you have your core directory set somewhere special you can override where the cores extract to. + + *** ### TO-DO @@ -32,5 +54,6 @@ python3 ./RetroUFO.py --help - ~~Auto detect platform & architecture~~ - Download progress bar - ~~Keep downloaded archives~~ -- Give better console output +- ~~Make GUI~~~ - Real error handling +- Support for ARM detection