aboutsummaryrefslogtreecommitdiffstats
path: root/packaging/macosx/Logray_read_me_first.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'packaging/macosx/Logray_read_me_first.adoc')
-rw-r--r--packaging/macosx/Logray_read_me_first.adoc34
1 files changed, 34 insertions, 0 deletions
diff --git a/packaging/macosx/Logray_read_me_first.adoc b/packaging/macosx/Logray_read_me_first.adoc
new file mode 100644
index 0000000000..f5fb0febb6
--- /dev/null
+++ b/packaging/macosx/Logray_read_me_first.adoc
@@ -0,0 +1,34 @@
+// Required attributes:
+// include-dir
+// min-macos-version
+
+include::{include-dir}/attributes.adoc[]
+:stylesheet: {include-dir}/../docbook/ws.css
+
+== Before You Begin
+
+This release of Logray requires macOS {min-macos-version} or later.
+If you are running an earlier version of macOS you can install using another packaging system such as Homebrew or MacPorts.
+
+== Quick Setup
+
+To install Logray, drag the _Logray_ application bundle to the _Applications_ folder.
+
+////
+If you would like to add the path to
+https://www.wireshark.org/docs/man-pages/wireshark.html[Logray],
+https://www.wireshark.org/docs/man-pages/tshark.html[TShark],
+https://www.wireshark.org/docs/man-pages/capinfos.html[capinfos],
+https://www.wireshark.org/docs/man-pages/editcap.html[editcap],
+and
+https://www.wireshark.org/docs/man-pages/[other command line utilities]
+to the system PATH, install the
+link:Logray.app/Contents/Resources/Extras/Add%20Wireshark%20to%20the%20system%20path.pkg[Add Logray to the system path]
+package.
+////
+
+== Uninstalling
+
+To uninstall Logray, do the following:
+
+. Remove _/Applications/Logray.app_