From 3709e9fb0553f618b9aa4a7cb1f431d208cd0e9f Mon Sep 17 00:00:00 2001 From: Paul M Date: Thu, 5 Oct 2023 15:13:40 -0500 Subject: [PATCH] Readme update --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b620258..2b7d98c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # syssetup -This system was created to allow of easy recreation or restoration of a existing system. This is not a backup application, nor does it create a image in the sense of a full disk image. It creates a snapshot of the current system configuration and installed packages. Once this information is collected it is packaged into standalone self extracting restore archive. It does this by copying your /etc folder and generating a list of installed programs via apt. These are then packaged into executable you can copy and run on another system. Great for duplicating a say a raspberry pi configuration. Works well for VPS systems as well, especially when you just need to do a clean reinstall. +This system was created to allow of easy recreation or restoration of a existing system. This is not a backup application, nor does it create a image in the sense of a full disk image. It creates a snapshot of the current system configuration and installed packages. Once this information is collected it is packaged into standalone self extracting restore archive. It does this by copying your /etc folder and generating a list of installed programs via the package manager on the system. These are then packaged into executable you can copy and run on another system. Great for duplicating a say a raspberry pi configuration. Works well for VPS systems as well, especially when you just need to do a clean reinstall. # Scripts -check.bash - The main program. Generates snapshots and can be used to easily install makeself(required). -restore.bash - The program that is run when you run the created archive. It gives you the option to restore or exit. Also processes the required step to recreate things. +check.bash - checks if makeself is installed +os_probe.bash - checks if we are on a debian or arch based distro via looking for apt or pacman +restore.*.bash - these are scripts specific to debian or arch +syssetup.bash - The main program +test.bash - Some file I was using to test something, you can ignore it # Plans