aboutsummaryrefslogtreecommitdiff
path: root/src-qt5/desktop-utils/lumina-archiver/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src-qt5/desktop-utils/lumina-archiver/README.md')
-rw-r--r--src-qt5/desktop-utils/lumina-archiver/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/src-qt5/desktop-utils/lumina-archiver/README.md b/src-qt5/desktop-utils/lumina-archiver/README.md
new file mode 100644
index 00000000..3ecd6558
--- /dev/null
+++ b/src-qt5/desktop-utils/lumina-archiver/README.md
@@ -0,0 +1,30 @@
+## Archive Manager for the Lumina Desktop
+
+This is a graphical archive manager based around the `tar` utility, which also provides limited support to copying USB images to a USB device via the `dd`utility.
+
+### Library Dependencies
+
+1. Qt 5.2+ (specific modules listed below)
+ * concurrent
+ * core
+ * gui
+ * network
+ * multimedia
+ * svg
+ * widgets
+2. Other Libraries
+ * libc
+
+### Runtime Utilities
+
+1. Required utilities
+ * `tar`: Used for the backend archive control system
+ * `dd`: Used to copy an image file ("*.img") to a USB device
+
+### Command Line arguments
+
+* `--burn-img` launches burn dialog as soon as lumina-archiver loads.
+ * Example : `$ lumina-archiver --burn-img ./TrueOS-2017-07-05-x64-USB.img`
+* `--ax` preforms auto-extraction on file into new directory created with the same name as the given file.
+ * Example : `$ lumina-archiver --ax ./lumina-master.zip`
+
bgstack15