Added some notes on API documentation.

(transplanted from 7ee477e62e86838eca158df16a724d417eef125f)
icculus · Sep 27, 2017 · 12b7a80 · 12b7a80
1 parent 9e75631
commit 12b7a80
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/README-API-documentation.txt b/docs/README-API-documentation.txt
@@ -0,0 +1,18 @@
+The API documentation is readable in a few ways:
+
+- Read physfs.h; it's _heavily_ documented and the primary source of reference
+  documentation for the library.
+- Run Doxygen over the header, which produces nicer-to-browse documentation in
+  HTML, LaTeX, manpage, etc formats. This is done for you if Doxygen is
+  installed and you build the "docs" target in whatever project files CMake
+  generated for you.
+- Too much trouble? We generated the HTML reference for you, online here:
+
+      https://icculus.org/physfs/docs/
+
+- We would love well-written tutorials for the latest version of PhysicsFS!
+  If you write one, we would love to list it here. Drop me a line about it:
+  icculus@icculus.org ... Thanks!
+
+--ryan.
+