Prepare to release to public.HEADmaster

1 files changed, 57 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..eada587
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+SaveGame Saver
+==============
+
+Save your savegames.
+
+Source: <https://source.gudinoff.com/dam/savegame-saver>  
+Contact: <https://www.gudinoff.com/dam/contact.html>
+
+---
+
+So you bought a good old game and you want to backup/restore your
+savegames? Maybe this tool is for you!
+
+# Wow, I'm sold... let me try it!
+
+Not so fast kiddo! Since there is no such thing as magic, you'll need to
+configure the tool before using it. It's pretty simple, just open the
+"sgs" file with a text editor and follow the notes. Because this is a
+bash script file, the notes are the lines that start with the
+number-sign \#. Except for the first line, that's just a shebang, don't
+touch it.
+
+# But seriously, how can I use it?
+
+You see, this is not one of those programs that needs to be installed
+and whatnot. You just use the "sgs" script directly from your command
+line. Let's start by extracting the contents of the downloadable file.
+For that, you'll need a [Zstandard](https://en.wikipedia.org/wiki/Zstd)
+compression tool (the script also uses it internally because of its
+overall better performance). Once the extraction is finished, let's make
+the script file executable with the following command:
+
+    `chmod +x sgs.sh`  
+
+To make it easier to use, why not move it to one of the standard $PATH
+directories? This allows you to call the script by its name from
+anywhere.  
+
+    `sudo mv sgs.sh /usr/local/bin/sgs`  
+
+Now you should be able to just type sgs and use the script. Go ahead...
+type it for more help:
+
+    `sgs -h`  
+
+# What's the catch?
+
+Unfortunately, there are a couple. First, keep in mind that you will
+need to configure it for every new game you want to support... as I
+said, there's no magic. Second, it detects if a game is installed by
+looking for its savegame directory. This isn't a bulletproof solution,
+but it's good enough.  
+
+# License
+
+Licensed under GPL-3.0-or-later.  
+SPDX-License-Identifier: GPL-3.0-or-later.