From d4d74dd3f8905f8c0cf2ffc66dfdc191636bb63f Mon Sep 17 00:00:00 2001
From: JeremyStarTM <jeremystartm@staropensource.de>
Date: Fri, 15 Mar 2024 01:39:21 +0100
Subject: [PATCH] Add README and .gitignore

---
 .gitignore |  2 ++
 README.md  | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6ac048f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+# Ignore repositories
+jstmbash
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..50e88c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# jstm's sysdotfiles
+## Read this first!
+Running `install.sh` or `uninstall.sh` will delete and change some things in your /etc and /usr/local/bin directories!
+### Affected directories
+- /etc/jstmbash
+- /etc/pacman.d
+### Affected files
+- /etc/bash.bashrc
+- /etc/jstmbash.env
+- /etc/pacman.conf
+- /etc/makepkg.conf
+
+## Recommendation
+Please, do not modify any files. It will only cause issues during the update process. \
+If you wish to make your own system dotfiles repo, you can of course modify files and then make your own repository.
+
+## Managing
+### Installing
+This will remove all related files and install some software. \
+*** WARNING: Please back up all files listed above, most important are `/etc/pacman.conf`, `/etc/pacman.d` and `/etc/makepkg.conf` since you'll likely need these to reinstall all other packages to restore their configuration files. Backing up all files and directories though is HIGHLY RECOMMENDED***
+```bash
+git clone https://git.staropensource.de/JeremyStarTM/syspunktdateien.git "/etc/sysdotfiles"
+cd "/etc/sysdotfiles"
+./install.sh
+```
+### Updating
+This will remove all related files, pull and then link everything again – automatically.
+```bash
+sysdotfiles-updater
+```
+### Uninstalling
+This will reset all programs to their original state and remove `/etc/sysdotfiles` completely. \
+***WARNING: This will erase all installed configuration files and directories. Please reinstall all packages with your package manager, if it's even functional. Please use your backed up files. If you didn't back them up, shoot yourself in the foot.***
+```bash
+cd "/etc/sysdotfiles"
+env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
+cd "/"
+rm -rf "/etc/sysdotfiles"
+```
+### Repairing
+This will *should* repair any issues you could have with this repository.
+```bash
+cd "/etc/sysdotfiles"
+env REMOVE_INSTALLBIT=true REMOVE_REPOSITORIES=true ./uninstall.sh
+./install.sh
+"/usr/local/bin/sysdotfiles-updater" --force
+```
+If you are still facing issues, contact me.