summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorPřemysl Eric Janouch <p@janouch.name>2024-11-28 09:31:11 +0100
committerPřemysl Eric Janouch <p@janouch.name>2024-11-28 11:22:32 +0100
commit9d619115beea442d05ccb243cd95cbb613cebc87 (patch)
tree33c93e3cf8cc0cedfe39fa52e78402be2edccf95 /README.adoc
parent02da76e9583030d0b5742687b16a77641b232cbe (diff)
downloadusb-drivers-9d619115beea442d05ccb243cd95cbb613cebc87.tar.gz
usb-drivers-9d619115beea442d05ccb243cd95cbb613cebc87.tar.xz
usb-drivers-9d619115beea442d05ccb243cd95cbb613cebc87.zip
Port eizoctltray to macOS
Also bump minimum CMake version for hidapi_ROOT, and don't try to run the help2man Perl script in MSYS2. AppKit is a very miserable thing.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc28
1 files changed, 26 insertions, 2 deletions
diff --git a/README.adoc b/README.adoc
index 80e7de6..83d859e 100644
--- a/README.adoc
+++ b/README.adoc
@@ -19,11 +19,12 @@ and may not run at the same time, as it would contend for device access.
eizoctltray
~~~~~~~~~~~
-_eizoctltray_ is a derived Windows utility that can stay in the systray.
+_eizoctltray_ is a derived Windows/macOS utility that can stay in the systray.
When holding the Shift or Control keys while switching signal inputs,
it will also suspend or power off the system, respectively.
-image::eizoctltray.png["eizoctltray with expanded context menu", 343, 229]
+image:eizoctltray-win.png["eizoctltray on Windows with expanded menu", 343, 278]
+image:eizoctltray-mac.png["eizoctltray on macOS with expanded menu", 343, 278]
elksmart-comm
~~~~~~~~~~~~~
@@ -77,6 +78,29 @@ Or you can try telling CMake to make a package for you. For Debian it is:
$ cpack -G DEB
# dpkg -i usb-drivers-*.deb
+Windows
+~~~~~~~
+You can either build within an MSYS2 environment,
+or cross-compile using Mingw-w64:
+
+ $ sh -e cmake/Win64Depends.sh
+ $ cmake -DCMAKE_TOOLCHAIN_FILE=liberty/cmake/toolchains/MinGW-w64-x64.cmake \
+ -DCMAKE_BUILD_TYPE=Release -B build
+ $ cmake --build build
+
+macOS
+~~~~~
+You can either build _eizoctltray_ against Homebrew,
+or link hidapi statically for a standalone portable app:
+
+ $ git clone https://github.com/libusb/hidapi.git
+ $ cmake -S hidapi -DBUILD_SHARED_LIBS=OFF \
+ -DCMAKE_INSTALL_PREFIX=$PWD/hidapi-build \
+ -DCMAKE_BUILD_TYPE=Release -B hidapi-build
+ $ cmake --build hidapi-build -- install
+ $ cmake -Dhidapi_ROOT=$PWD/hidapi-build -DCMAKE_BUILD_TYPE=Release -B build
+ $ cmake --build build
+
Contributing and Support
------------------------
Use https://git.janouch.name/p/usb-drivers to report bugs, request features,