changeset 302:675865737a23

docs: clean up documentation
author Paper <paper@paper.us.eu.org>
date Mon, 13 May 2024 15:18:20 -0400
parents b1f625b0227c
children ab7ff259b4ca
files dep/animone/README dep/animone/README.md rc/icons/README rc/icons/README.md
diffstat 4 files changed, 46 insertions(+), 38 deletions(-) [+]
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 :)
--- a/dep/animone/README.md	Mon May 13 15:04:51 2024 -0400
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,36 +0,0 @@
-# Animia
-Animia 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, Animia currently does not support UI automation, i.e., most
-web browsers will not work properly, if at all.
-
-Animia 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
-
-### Windows
-To get the currently opened file handles on Windows, Animia has to use internal
-kernel functions. However, these functions aren't likely to change anytime soon.
-
-### macOS
-The code to retrieve executable names on macOS uses internal functions. However,
-if these functions cannot be found for whatever reason, it falls back to parsing
-the arguments, and then to calling the kernel.
-
-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 Animia will try to grab before falling back to the Quartz window name.
-
-### X11
-Animia requires that the XRes extension is installed to retrieve window PIDs.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/rc/icons/README	Mon May 13 15:18:20 2024 -0400
@@ -0,0 +1,4 @@
+These icons are from Yusuke Kamiyamane's Fugue Icons[1] pack.
+There are no changes divergent from any of the original files.
+
+[1]: https://p.yusukekamiyamane.com/
\ No newline at end of file
--- a/rc/icons/README.md	Mon May 13 15:04:51 2024 -0400
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,2 +0,0 @@
-# Icons
-These icons are from Yusuke Kamiyamane's [[Fugue Icons]](https://p.yusukekamiyamane.com/) pack. The original files have been left intact alongside bin2h variants (for easy inclusion in source code).
\ No newline at end of file