aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2fbc3c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# ThirdPartyInstallers
+
+This is a collection of utilities to handle the installation of packages in non-native formats such as RPM and DEB.
+
+Packages are unpacked under `/Programs`. The contents of `/opt`, when present, are flattened under the new program entry
+and compatibility symlinks are created at /opt pointing back to the new entry at `/Programs`.
+
+# Caveats
+
+Note that running packages built for other distributions is a best-effort task. There are many features that won't
+work out of the box and that are outside the scope of `ThirdPartyInstallers`. For instance, init scripts, tasks files,
+and reliance on other distro-specific components may preclude the installed package from working as expected.
+
+# Usage
+
+Installing a single RPM file:
+
+`$ InstallPackage-RPM libfoo-2.1-3.x86_64.rpm`
+
+Merging multiple RPMs under a single entry at `/Programs`:
+
+`$ InstallPackage-RPM --app-name "LibreOffice" --version-number 5.2.3.3 *.rpm`