From 65e1f8cdac0b91c72a01816d61fa554d8583f2ed Mon Sep 17 00:00:00 2001 From: CHristian Moser Date: Wed, 26 Mar 2025 19:46:33 +0100 Subject: [PATCH] Added installation-guide to README.md --- README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 82 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index afdd2c9..aac953d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,82 @@ -# sgbackup -Savegame Backup Utility +# sgbackup - SaveGame Backup + +## Install + +### Requirements + +* Python 3 >= 3.11 +* pip +* GObject + GObject Introspection for Python +* Gtk4 + Python bindings +* GIT + + +### All OSes + +````shell +# Download sgbackup +git clonse https://github.com/c9moser/sgbackup.git + +# change to sgbackup directory +cd sgbackup + +# install requirements +pip install -r requirements.txt + +# install sgbackup +pip install . +```` + +### Windows + + Download *MSYS2* from [the MSys2 site](https://www.msys2.org) + and install it. To update *MSYS2* to the latest version + start a MSYS2 terminal and run: + +```shell +pacman -Syu +``` + +If the terminal quits, restart it and run the above command again. + +Install git and download *sgbackup* and install it. + +```shell +# Install git +pacman -S git + +# Download sgbackup. +git clone https://github.com/c9moser/sgbackup.git + +# Switch to the sgbackup directory and run the installer. +cd sgbackup +./msys-install.sh +``` + +### Fedora + +````shell +# install git +sudo dnf install -y git + +# download sgbackup +git clone https://github.com/c9moser/sgbackup.git + +# cd to sgbackup-directory and install sgbackup +cd sgbackup +./fedora-install.sh +```` + +### Cent OS 10 / Alma Linux 10 + +````shell +# install git +sudo dnf install -y git + +# download sgbackup +git clone https://github.com/c9moser/sgbackup.git + +# cd to sgbackup-directory and install sgbackup +cd sgbackup +./centos-install.sh +````