Mercurial > minori
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 301:b1f625b0227c | 302:675865737a23 |
|---|---|
| 1 Animone is a work-in-progress cross-platform hard fork of Anisthesia and part of | |
| 2 Minori. | |
| 3 | |
| 4 Most (if not all) Anisthesia configs should also work in this library as well | |
| 5 (at least on Windows). | |
| 6 | |
| 7 --- LICENSE --- | |
| 8 Changes divergent from Anisthesia are under the BSD 3-clause license. You can | |
| 9 find a copy of the original MIT license bundled with Anisthesia at `LICENSE.MIT` | |
| 10 in the root folder. | |
| 11 | |
| 12 --- SUPPORT --- | |
| 13 Unlike Anisthesia, Animone currently does not support UI automation, i.e., most | |
| 14 web browsers will not work properly, if at all. | |
| 15 | |
| 16 Animone will first attempt to connect to a windowing system. If that fails, it | |
| 17 falls back to just enumerating over the open processes in the system. | |
| 18 | |
| 19 --- PLATFORM-SPECIFIC QUIRKS --- | |
| 20 Because Animone supports multiple different platforms, there are some quirks to | |
| 21 keep in mind while using the library. | |
| 22 | |
| 23 To get the currently opened file handles on Windows, Animone uses internal | |
| 24 kernel functions (however, these are unlikely to change in the future). | |
| 25 | |
| 26 The code to retrieve executable names on macOS calls the kernel, and said kernel | |
| 27 functions aren't guaranteed to have the same API with each release. However, it | |
| 28 has stayed relatively stagnant since 10.4 Tiger's release, so any release after | |
| 29 it should work perfectly fine. | |
| 30 | |
| 31 Additionally, macOS does not have the concept of class names, rather, it has | |
| 32 bundle identifiers, which are a suitable replacement in most use cases, and are | |
| 33 what Animone will attempt to grab before falling back to the Quartz window name. | |
| 34 | |
| 35 On X11, Animone requires that the XRes extension is installed to retrieve window | |
| 36 PIDs. | |
| 37 | |
| 38 --- HISTORY --- | |
| 39 Animone used to be under the name Animia, as in you'd contract anemia just from | |
| 40 looking at the source code. It's been cleaned up a bit since then, so now it's | |
| 41 been changed to represent Anemone, a genus of flowering plants commonly called | |
| 42 windflowers :) |