From 9ba970b9b04d5f195286de38ed4d873d8c803ef3 Mon Sep 17 00:00:00 2001 From: MNTLe Date: Wed, 10 May 2023 17:15:38 +1200 Subject: [PATCH] Update 'README.md' --- README.md | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 288c1c4..b5fb1da 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ -# DOSBox_Game_Runner +# DOSBox Game Runner -A short python script to run a game in DOSBox. \ No newline at end of file +A simple Python script to run DOS games in DOSBox. + +## Description + +This script is designed to make it easy to run DOS games in DOSBox on modern operating systems. It provides a GUI interface for configuring the DOSBox environment and launching the game. + +The script reads configuration settings from a `dbgr.conf` file, which can be edited using the included `config_editor.py` script. + +## Requirements + +- Python 3.x +- DOSBox + +## Installation + +1. Install DOSBox. +2. Clone the repository or download the source code. +3. Run `pip install -r requirements.txt` to install dependencies (PyQt5 and configparser). +4. Edit `dbgr.conf` to configure DOSBox settings for your system. + +## Usage + +1. Launch `game_runner.py`. +2. Use the `config_editor.py` script to edit the configuration settings as needed. +3. Click the "Launch Game" button to start the configured game in DOSBox. + +## Contributing + +Contributions are welcome! If you encounter any bugs or issues, please submit them via the issue tracker. Pull requests with bug fixes and new features are also welcome. + +## License + +This project is licensed under the MIT License. See `LICENSE` for details. + \ No newline at end of file