wrote readme

README.md

@@ -6,61 +6,116 @@
   - [What is this?](#what-is-this)
   - [Install](#install)
     - [Precompiled binaries](#precompiled-binaries)
-  - [Example 'config.json'](#example-configjson)
+    - [Run from source](#run-from-source)
+  - [Setup the 'config.json'](#setup-the-configjson)
   - [Future ideas](#future-ideas)
-  - [Wanna help?](#wanna-help)
   - [Urgent TODOs](#urgent-todos)
+  - [Wanna help?](#wanna-help)
   - [FAQ](#faq)
+  - [Other SMW (US) checksums](#other-smw-us-checksums)
 
 ## What is this?
 
 Depending on your perspective, this can be several. Mostly, its a handy tool to browser and search for [SMW hacks](https://www.smwcentral.net/?p=section&s=smwhacks) on [SMW Central](https://www.smwcentral.net/). This tool allows you to browse through all SMW hacks submissions, search with specific filters, lets you download and patch your SMW SFC file and launches the patched ROM with your favorite emulator!
 
 From another perspective, a part of this project is a crawler (for the submession table-like pages as of right now), which allows you to interact with the submessions on a more developer friendly way. Maybe you want to build your own browser, then you might want to check out [this subfolder](source/smwc)!
 
+This project was mainly created to be compatible with the Steam Deck, but should work on any platform, that supports Python!
+
 ## Install
 
 There are two way for you to install this. You can download precompiled binaries or clone this repo and run it from the source code!
 
 ### Precompiled binaries
 
-## Example 'config.json'
+You can get the [latest precompiled binaries](https://github.com/R3tr0BoiDX/smwc-browser/releases/latest) from the releases section. Just download them and execute them! It's nearly that easy!
+
+### Run from source
+
+If you prefer to run the program from the source, the run the following commands:
+
+```bash
+# Install python3 and python3-venv
+apt install python3 python3-venv
+
+# Clone repository
+git pull https://github.com/R3tr0BoiDX/smwc-browser.git
+
+# Change into folder with source
+cd smwc-browser
+
+# Create virtual environment
+python3 -m venv .venv
+source .venv/bin/activate
+pip3 install -r requirements.txt -r requirements-dev.txt
+
+# Run the browser
+python3 -m source.main
+```
+
+> :warning: These instructions are intended for Linux-based systems. If you're using Windows, you can achieve similar results with PowerShell. You cannot use the `apt` command, so you'll need to manually [install Python](https://www.python.org/downloads/windows/) and change the `source.venv/bin/activate` command with `.\.venv\Scripts\Activate.ps1`.
+
+## Setup the 'config.json'
+
+No matter if you run from source or you prefer the precompiled binaries, both come with the [`config.example.json`](https://github.com/R3tr0BoiDX/smwc-browser/blob/master/config.example.json). You will need to **rename** this to `config.json` and fill out all the entries. It will look something like this:
 
 ```json
 {
-
- "library_path": "/path/to/your/location/where/to/save/patched/file/",
- "launch_program": "/path/to/application/to/launch/patched/file/with"
+ "sfc_path": "home/user/Games/baserom.us.sfc",
+ "library_path": "/home/user/Games/",
+ "launch_program": "emulatorGX"
 }
 ```
 
-> :warning: Windows handels its path then Linuxa and you will need to escape your paths! They will look something like this: `"sfc_path": "C:\\Users\\User\\Games\\baserom.us.sfc`
+Let's take a look at all the entries:
+
+- **`sfc_path`**: This is the way to find your SMW (US) SFC file. It **must** have a CRC32 code of `B19ED489`, or else you have the incorrect ROM and the SMW Central Browser won't launch. A built-in checksum test verifies if you have the proper ROM. Different checksums are listed [below](#other-smw-us-checksums).
+- **`library_path`**: This is where the patched ROMs files will be saved. If you use RetroArch or a similar program and want the patched games to show up in your collection, this is for you!
+- **`launch_program`**, optional: After the ROMs have been patched, you can open them automatically with a program of your choice, allowing you to play right away!
+
+> :warning: Windows handles its paths differently than Linux, and you will need to escape your paths! They will look something like this: `"sfc_path": "C:\\Users\\User\\Games\\baserom.us.sfc`
 
 ## Future ideas
 
-*In order of importance:*
+*In order of significance:*
 
-- File browser for unzipped hack, if there are multiple patch files
-  - Should include an option to show all files and apply them as patches if the user wishes so
 - Wrapper and screen for hack entry site
 - Wrapper for hack screenshots and display in browser
 - Save filter parameter
+- File browser for unzipped hack, if there are multiple patch files
+  - Should include an option to show all files and apply them as patches if the user wishes so
 - Maybe a way to delete downloaded hacks from library?
 - Support for SMW2:YI and SM64
+- Settings screen
+- Argument to disable checksum check
 - Language support
 
+**Constructive criticism and ideas for improvements are also always welcome!**
+
+## Urgent TODOs
+
+- Linting (and a lil bit refactoring)
+- Better gamepad support and scrolling
+
 ## Wanna help?
 
 This project entirely in my free time next to my full time job. Soon, ill write my bachelor thesis and will have much less time for this project. So, if you wanna contribute and help with any feature, you're welcome! We need tests, bug fixes and new features would be nice as well. I much appreciate your consideration! :slightly_smiling_face:
 
-Constructive criticism and ideas for improvements are also always welcome!
+## FAQ
 
-## Urgent TODOs
+**Will there be support for SMW2:YI and SM64?**
 
-- linting (and a lil bit refactoring)
-- better gamepad support and scrolling
+Maybe one day! It's certainly a nice idea and in theory not to hard to implement.
 
-## FAQ
+**I can't find my question!**
+
+Feel free to open a new issue, just please the *question* label :slightly_smiling_face:
+
+## Other SMW (US) checksums
+
+If you would rather use a different checksums, below are alternative SMW (US) checksums. If your ROM matches these, it should also pass the CRC32 check.
 
-> Will there be support for SMW2:YI and SM64?
-Maybe one day! Its certainly a nice idea and in theory not to hard to implement
+- SHA-1: `6B47BB75D16514B6A476AA0C73A683A2A4C18765`
+- SHA256: `0838E531FE22C077528FEBE14CB3FF7C492F1F5FA8DE354192BDFF7137C27F5B`
+- MD5: `CDD3C8C37322978CA8669B34BC89C804`
+- CRC32: `B19ED489`