Add documentation.

fredjt · fredjt · commit b2c627decb48 · 2025-12-17T00:41:49.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.idea/
+cmake-build-*/
diff --git a/AUTHORS b/AUTHORS
@@ -0,0 +1 @@
+Trent Tanchin <trent@tanchin.org>
diff --git a/INSTALL.md b/INSTALL.md
@@ -0,0 +1,19 @@
+# Building and Installing ABII-example-logging-plugin
+
+To build ABII-example-logging-plugin, obtain
+the <a href=https://github.com/fredjt/ABII-example-logging-plugin/releases/latest>latest sources</a>, unpack them, and
+enter the source directory. Then,
+
+```
+mkdir build
+cd build
+
+cmake .. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr -GNinja
+ninja
+sudo ninja install
+```
+
+To install in a local directory instead of system-wide in /usr, change CMAKE_INSTALL_PREFIX to the directory of
+choice. \
+A 32-bit plugin can be created with the cmake option -DBIT32=ON and optionally -DCMAKE_INSTALL_LIBDIR=lib32. This is
+required for building plugins that will be injected into 32-bit applications like steam. 
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,14 @@
+Copyright © 2025 Trent Tanchin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the “Software”), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,3 @@
+# ABII-example-logging-plugin
+
+This is an example of an ABI call-logging plugin for the <a href=https://github.com/fredjt/ABII>ABII project</a>. 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# ABII-example-logging-plugin`
	`2`	`+`
	`3`	`+This is an example of an ABI call-logging plugin for the <a href=https://github.com/fredjt/ABII>ABII project</a>.`