Update basic Doxygen documentation

Koromix · Nov 20, 2021 · 120509e · 120509e
1 parent 3d33863
commit 120509e
Show file tree

Hide file tree

Showing 6 changed files with 496 additions and 343 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ bin/
 CMakeLists.txt.*
 *.pro.*
 .tags*
+src/libhs/doc/pages
 
 # I like to keep a bunch of test firmwares around
 *.hex

diff --git a/src/libhs/README.md b/src/libhs/README.md
@@ -2,10 +2,11 @@ libhs
 =====
 
 libhs is a C library to enumerate HID and serial devices and interact with them. It is:
-- **cross-platform**: supports Windows (Vista or more), Linux and Mac OS X.
-- **driverless**: uses native OS-provided interfaces and does not require custom drivers.
 
-You can download the library in the [release section](https://github.com/Koromix/libhs/releases).
-Pre-built binaries are available for Windows (MSVC 2015 and MinGW-w64) and Mac OS X (Clang).
+- **single-file**: one header is all you need to make it work.
+- **public domain**: use it, hack it, do whatever you want.
+- **multiple platforms**: Windows (≥ Vista), Mac OS X (≥ 10.9) and Linux.
+- **multiple compilers**: MSVC (≥ 2015), GCC and Clang.
+- **driverless**: uses native OS-provided interfaces and does not require custom drivers.
 
-Refer to the [Doxygen documentation](https://koromix.github.io/libhs) for more information.
+You can download the library in the [release section](https://github.com/Koromix/libraies).
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,7 @@ bin/ @@
     CMakeLists.txt.*
     *.pro.*
     .tags*
+    src/libhs/doc/pages
     # I like to keep a bunch of test firmwares around
     *.hex
@@ Expand Down @@