updated readme

README.md

@@ -7,12 +7,13 @@
   - [Install](#install)
     - [Precompiled binaries](#precompiled-binaries)
     - [Run from source](#run-from-source)
-  - [Setup the 'config.json'](#setup-the-configjson)
+  - [Setup the `config.json`](#setup-the-configjson)
+  - [Command line arguments](#command-line-arguments)
   - [Future ideas](#future-ideas)
   - [Urgent TODOs](#urgent-todos)
   - [Wanna help?](#wanna-help)
-  - [FAQ](#faq)
   - [Other SMW (US) checksums](#other-smw-us-checksums)
+  - [FAQ](#faq)
 
 ## What is this?
 
@@ -55,7 +56,7 @@ 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'
+## 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:
 
@@ -69,12 +70,20 @@ No matter if you run from source or you prefer the precompiled binaries, both co
 
 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).
+- **`sfc_path`**: This is the path 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 right 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`
 
+## Command line arguments
+
+There aren't many command line arguments, but there a some. Right now there are:
+
+- **`-l`, `--no-launch`**: Don't launch the patched file using the program defined in the configuration file once patching is complete. If no program is defined, no program will be launched anyway.
+- **`-f`, `--no-fullscreen`**: Don't start the browser in fullscreen mode.
+- **`-h`**: Displays a help screen
+
 ## Future ideas
 
 *In order of significance:*
@@ -101,6 +110,15 @@ Let's take a look at all the entries:
 
 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:
 
+## 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.
+
+- SHA-1: `6B47BB75D16514B6A476AA0C73A683A2A4C18765`
+- SHA256: `0838E531FE22C077528FEBE14CB3FF7C492F1F5FA8DE354192BDFF7137C27F5B`
+- MD5: `CDD3C8C37322978CA8669B34BC89C804`
+- CRC32: `B19ED489`
+
 ## FAQ
 
 **Will there be support for SMW2:YI and SM64?**
@@ -110,12 +128,3 @@ Maybe one day! It's certainly a nice idea and in theory not to hard to implement
 **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.
-
-- SHA-1: `6B47BB75D16514B6A476AA0C73A683A2A4C18765`
-- SHA256: `0838E531FE22C077528FEBE14CB3FF7C492F1F5FA8DE354192BDFF7137C27F5B`
-- MD5: `CDD3C8C37322978CA8669B34BC89C804`
-- CRC32: `B19ED489`