]> git.seodisparate.com - UDPConnection/commitdiff
Update README.md
authorStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 10:14:34 +0000 (19:14 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Mon, 13 Jan 2020 10:14:34 +0000 (19:14 +0900)
README.md

index 417be99c157a1821251fa0b64628f649da3a0d0c..76d5552f7be2d8560d3c2cfa9ba63ea8a2f989ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
 # UDPConnection
 
 Provides a network connection over UDP, with verification of packet support via
-libsodium (optional). Implemented in C++, but is available via a C api, which
-should facilitate creating bindings for other programming languages if needed.
+libsodium (optional). Implemented in C++ (up to C++11 standard), but is
+available via a C api, which should facilitate creating bindings for other
+programming languages if needed.
 
 This library is still a work in progress, so api breaking changes may happen
 in the future.
@@ -24,3 +25,10 @@ created by invoking `doxygen Doxyfile` in the root directory of the project.
 
 The program in `src/test/UDPC_NetworkTest.c` is used for testing UDPConnection
 and is also an example of using the library in a C program.
+
+## Debug Builds
+
+NetworkTest only builds when CMAKE\_BUILD\_TYPE is Debug (default).
+
+UnitTest only builds in Debug mode and if GTest (a unit testing framework) is
+available.