diff options
author | TheRealKeto <therealketo@gmail.com> | 2021-08-05 17:03:20 -0400 |
---|---|---|
committer | Cameron Katri <me@cameronkatri.com> | 2021-08-08 12:11:13 -0400 |
commit | d2752a757a50217682e1f3ace79933e8991623c0 (patch) | |
tree | 82fd78e2d547af9013053c4eac43b16d4fbae9b2 | |
parent | 97568a5a83c5848f5b9fcde7f200c73a77460e21 (diff) | |
download | snaprestore-d2752a757a50217682e1f3ace79933e8991623c0.tar.gz snaprestore-d2752a757a50217682e1f3ace79933e8991623c0.tar.zst snaprestore-d2752a757a50217682e1f3ace79933e8991623c0.zip |
New README (with building notes)
- Add more info about the project
- Add installation/building instructions
- Specify what license the project is under
Signed-off-by: Cameron Katri <me@cameronkatri.com>
-rw-r--r-- | README.md | 34 |
1 files changed, 28 insertions, 6 deletions
@@ -1,9 +1,31 @@ # snaprestore -`Usage: snaprestore [volume] [snapshot]` +> snaprestore [volume] [snapshot] -Fair amount of testing -Renames snapshot to original name -Removes jailbreak apps from icon cache -Clean up `/var` -Works on any jailbreak (hopefully) +Easily restore rootfs from the command line. + +## Features + +* Fair amount of testing +* Cleans up `/var` +* Renames snapshot to original name +* Removes jailbreak apps from icon cache +* Works on any jailbreak *(hopefully)* + +## Installation + +A build of `snaprestore` is available on [Procursus](https://github.com/ProcursusTeam/Procursus), which you can install if your device is already setup with an instance of the build system. + +Alternatively, you can compile `snaprestore` on your device using Make. + + make install + +If you need a Debian package for later use, use the following command + + make package + +Check out the [Makefile](Makefile) to see what options you might need to setup for `snaprestore` to build properly. + +## License + +`snaprestore` has been licensed under the [BSD-2 Clause License](LICENCE). |