From 41680b8c15bc7615b187a2d2b8cd66f83ebfc82a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20=C4=8Cudek?= <79476279+boofiboi@users.noreply.github.com> Date: Sun, 14 Jul 2024 19:00:22 +0200 Subject: [PATCH] Improve readme --- README.md | 40 +++++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 6cc67a6..63b83df 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,37 @@ -# Steam DLC Fetcher and installer for Linux -- Python script designed for linux to automate fetching of DLC id's for steam games and the installation of creamlinux automatically. -# Features +# Steam DLC Fetcher and installer for Linux +- Python script designed for linux to automate fetching of DLC id's for steam games and the installation of creamlinux automatically. [Demo](https://www.youtube.com/watch?v=22LDDUoBvus&ab_channel=Nova) +### Features - Automatically fetches and lists DLC's for selected steam game(s) installed on the computer. - Automatically installs creamlinux and its components into selected steam games, excluding and handling specific config files. - Provides a simple cli to navigate and operate the entire process. -# Demo -https://www.youtube.com/watch?v=22LDDUoBvus&ab_channel=Nova - -# To do -- Cross reference dlc files and dlc id's. Incase dlc id's and dlc files differ in terms of quantity it will notify the user. -- Possibly add functionality to search for dlc files/automatically installing them. -- Add the possibility to install cream/smokeapi for games running proton. -- Check if the game already has dlc files installed -- Gui? - -# Prerequisites +## Usage +### Prerequisites - `python 3.x` - `requests` library - `zipfile` library -# Usage + +### Installation + - Clone the repo or download the script. - Navigate to the directory containing the script. - Run the script using python. -```bash -python dlc_fetcher.py -``` -# Issues? +#### OR +Use this one-line shell script. +```bash +git clone https://github.com/Novattz/creamlinux-installer;cd creamlinux-installer;python dlc_fetcher.py +``` +## TODO +- [ ] Cross reference dlc files and dlc id's. Incase dlc id's and dlc files differ in terms of quantity it will notify the user. +- [ ] Possibly add functionality to search for dlc files/automatically installing them. +- [ ] Add the possibility to install cream/smokeapi for games running proton. +- [ ] Check if the game already has dlc files installed +- [ ] Gui? + +### Issues? - Open a issue and attach all relevant errors/logs. # Credits