From 7faa1359775024fb82c89d44f9dd56c392ffa3a3 Mon Sep 17 00:00:00 2001 From: Michael Loukeris Date: Sun, 29 Sep 2024 22:29:07 +0300 Subject: [PATCH] Add Readme --- README.md | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ src/app.py | 1 - 2 files changed, 96 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e69de29..0f0b805 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,96 @@ +# Artie + +Artie is a simple art scraper designed for Anbernic devices running MuOS. It helps you download and manage artwork for your ROMs, enhancing your gaming experience with beautiful visuals. + +## Features + +- Easy-to-use interface +- Supports multiple systems +- Integrates seamlessly with MuOS + +## Installation + +Follow these steps to install Artie: + +1. **Download the Latest Release**: + + - Visit the [releases page](https://github.com/milouk/artie/releases) and download the latest version of Artie. + +2. **Unzip the Downloaded File**: + + - Extract the contents of the downloaded zip file. + +3. **Configure Artie**: + + - Open `config.json` and add your ScreenScraper credentials. + - Customize other settings such as ROMs path, art path per system, etc. + +4. **Copy Files to MuOS**: + + - Copy the `.artie` directory and `Artie Scraper.sh` script to `/mnt/mmc/MUOS/application/`. + +5. **Launch Artie Scraper**: + - Open MuOS and launch Artie Scraper from your applications menu. + +## Usage + +1. **Run Artie Scraper**: + + - Navigate to the applications menu in MuOS and select Artie Scraper. + +2. **Scrape Artwork**: + + - Follow the on-screen instructions to scrape artwork for your ROMs. + +3. **Enjoy Enhanced Visuals**: + - View your ROMs with the newly downloaded artwork. + +## Contributing + +We welcome contributions! Feel free to open issues or submit pull requests (PRs) to help improve Artie. + +### How to Contribute + +1. **Fork the Repository**: + + - Click the "Fork" button at the top right of the repository page. + +2. **Clone Your Fork**: + + - Clone your forked repository to your local machine using `git clone`. + +3. **Create a Branch**: + + - Create a new branch for your feature or bug fix. + +4. **Make Changes**: + + - Implement your changes and commit them with clear and concise messages. + +5. **Submit a Pull Request**: + - Push your changes to your fork and submit a pull request to the main repository. + +## Bugs + +### Known Issues + +- **Screen Flickering**: There is a known issue with screen flickering. We are actively working on a fix. + +### Reporting Bugs + +If you encounter any bugs, please open an issue on the [GitHub issues page](https://github.com/milouk/artie/issues) with detailed information about the problem. + +## Roadmap + +### Upcoming Features + +- **Multithreading**: Implement multithreading to improve performance and speed up the scraping process. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + + +--- + +Thank you for using Artie! We hope it enhances your gaming experience on your Anbernic device. diff --git a/src/app.py b/src/app.py index 12627e3..49eaee1 100644 --- a/src/app.py +++ b/src/app.py @@ -129,7 +129,6 @@ def load_emulators(self) -> None: (20, 50 + (i * 35)), 600, i == (selected_position % max_elem), - logo, ) self.button_circle((30, 450), "A", "Select")