Mercurial > minori
diff dep/animone/README @ 302:675865737a23
docs: clean up documentation
author | Paper <paper@paper.us.eu.org> |
---|---|
date | Mon, 13 May 2024 15:18:20 -0400 |
parents | |
children | a7d4e5107531 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dep/animone/README Mon May 13 15:18:20 2024 -0400 @@ -0,0 +1,42 @@ +Animone is a work-in-progress cross-platform hard fork of Anisthesia and part of +Minori. + +Most (if not all) Anisthesia configs should also work in this library as well +(at least on Windows). + +--- LICENSE --- +Changes divergent from Anisthesia are under the BSD 3-clause license. You can +find a copy of the original MIT license bundled with Anisthesia at `LICENSE.MIT` +in the root folder. + +--- SUPPORT --- +Unlike Anisthesia, Animone currently does not support UI automation, i.e., most +web browsers will not work properly, if at all. + +Animone will first attempt to connect to a windowing system. If that fails, it +falls back to just enumerating over the open processes in the system. + +--- PLATFORM-SPECIFIC QUIRKS --- +Because Animone supports multiple different platforms, there are some quirks to +keep in mind while using the library. + +To get the currently opened file handles on Windows, Animone uses internal +kernel functions (however, these are unlikely to change in the future). + +The code to retrieve executable names on macOS calls the kernel, and said kernel +functions aren't guaranteed to have the same API with each release. However, it +has stayed relatively stagnant since 10.4 Tiger's release, so any release after +it should work perfectly fine. + +Additionally, macOS does not have the concept of class names, rather, it has +bundle identifiers, which are a suitable replacement in most use cases, and are +what Animone will attempt to grab before falling back to the Quartz window name. + +On X11, Animone requires that the XRes extension is installed to retrieve window +PIDs. + +--- HISTORY --- +Animone used to be under the name Animia, as in you'd contract anemia just from +looking at the source code. It's been cleaned up a bit since then, so now it's +been changed to represent Anemone, a genus of flowering plants commonly called +windflowers :)