diff --git a/README.md b/README.md index 539016a..4673f56 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,97 @@ -# OpenSuperClone +

+
+ OpenSuperClone +
+

-This is a fork of the HDDSuperClone source code () released under the GPL2 by Scott Dwyer. +

+ A powerful disk cloning utility for Linux with many advanced features based on Scott Dwyer's HDDSuperClone. +

-OpenSuperClone/HDDSuperClone is a powerful disk cloning utility for Linux akin to ddrescue with many advanced features. +

+ โœจ Features โ€ข + ๐Ÿ’พ Installation โ€ข + ๐ŸŽ›๏ธ Changelog โ€ข + ๐Ÿคน Credits โ€ข + ๐Ÿ“„ License +

-## Changes (since version 2.3.3_20220430 of HDDSuperClone) +

+ Size Limit CLI +

-- Cleanup of project files -- Implemented CMake as build system -- Removal of licensing related functions -- Switched from GTK2 to GTK3 -- Updated kernel driver to work on 5.15 +## โœจ Features -## Planned Changes +* Advanced drive cloning capability akin to that of ddrescue +* Virtual driver mode for targeted data extraction +* USB Relay control for automatic drive powercycling -- Refactoring of codebase (get rid of -fcommon flag) -- Implement DKMS for driver (un-)installation -- Remove requirement for running as root -- Get completely rid of GTK2 code -- Configuration files and presets for settings +### Planned Features -## Known Issues +* Refactoring of codebase (get rid of -fcommon flag) +* Implement DKMS for driver (un-)installation +* Remove requirement for running as root +* Get completely rid of GTK2 code +* Add configuration files and presets for settings -- OSCViewer is extremely buggy in GTK3 and missing functionality from its GTK2 counterpart, it is recommended to build it with GTK2 for the time being +### Known Issues -## Compiling and Running Locally +* OSCViewer is extremely buggy in GTK3 and missing functionality from its GTK2 counterpart, it is recommended to build it with GTK2 for the time being + +

+
+

+ +## ๐Ÿ’พ Installation + +Pre-built binaries aswell as Debian packages for OpenSuperClone can be found on the Release page. + +### Compiling from Source + +OpenSuperClone requires the following packages to be installed for a successful project build: + +- `gcc` +- `cmake` +- `pkgconf` +- `libusb-dev` +- `libgtk-3-dev` (or `libgtk2.0-dev` if building for GTK2) ```Bash -# Install required packages for building -./install-build-requirements.sh - # Build OpenSuperClone and OSCViewer for Release and install to ./release -./build.sh - -# Install dependencies for running -./install-dependencies-deb.sh +$ ./build.sh # Run OpenSuperClone -sudo ./release/bin/opensuperclone +$ sudo ./release/bin/opensuperclone # Run OSCViewer -./release/bin/osscviewer +$ ./release/bin/osscviewer ``` -## Installing Globally +

+
+

-Installation will build OpenSuperClone for Release and install binaries, scripts, -and translation files to /usr/local. Installation of the build requirements is necessary. +## ๐ŸŽ›๏ธ Changelog -```Bash -# Build OpenSuperClone and OSCViewer for Release and install to /usr/local -# (installation prefix can be changed by editing install.sh) -./install.sh +### OpenSuperClone 2.4 [Pre-Release] -# Run OpenSuperClone -sudo opensuperclone +* Cleanup of project files, removal of licensing related code +* Implemented CMake as build system +* Switched from GTK2 to GTK3 +* Updated kernel driver to work on 5.15 -# Run OSCViewer -oscviewer -``` \ No newline at end of file +

+
+

+ +## ๐Ÿคน Credits + +All credit belongs to Scott Dwyer with his work on HDDSuperClone. + +

+
+

+ +## ๐Ÿ“„ License + +This software is licensed under the [GPLv2](LICENSE). \ No newline at end of file diff --git a/doc/opensuperclone.png b/doc/opensuperclone.png new file mode 100644 index 0000000..70495a2 Binary files /dev/null and b/doc/opensuperclone.png differ diff --git a/install-build-requirements.sh b/install-build-requirements.sh deleted file mode 100755 index 5648e5e..0000000 --- a/install-build-requirements.sh +++ /dev/null @@ -1,11 +0,0 @@ -sudo apt-get install gcc -y -sudo apt-get install cmake -y -sudo apt-get install pkgconf -y -sudo apt-get install libusb-dev -y -sudo apt-get install libgtk-3-dev -y - -# Necessary for GTK2 build -# sudo apt-get install libgtk2.0-dev -y - -# Necessary for some debug related stuff -# sudo apt-get install libcurl4-gnutls-dev -y \ No newline at end of file diff --git a/install-dependencies-deb.sh b/install-dependencies-deb.sh deleted file mode 100755 index f015c90..0000000 --- a/install-dependencies-deb.sh +++ /dev/null @@ -1,3 +0,0 @@ -sudo apt-get install libusb-0.1 -y -sudo apt-get install make -y -sudo apt-get install gcc -y diff --git a/install-dependencies-red.sh b/install-dependencies-red.sh deleted file mode 100755 index c1d776a..0000000 --- a/install-dependencies-red.sh +++ /dev/null @@ -1,3 +0,0 @@ -sudo yum install libusb-0.1 -y -sudo yum install make -y -sudo yum install gcc -y