Explorar o código

Add README to document the status of examples

bel %!s(int64=8) %!d(string=hai) anos
pai
achega
38a99f7980
Modificáronse 2 ficheiros con 9 adicións e 0 borrados
  1. 1 0
      RELEASE_NOTES.md
  2. 8 0
      examples/README.md

+ 1 - 0
RELEASE_NOTES.md

@@ -7,6 +7,7 @@ Changes
 
 - Add library init/exit functions (calls will be required in later versions)
 - Add Lua background script, running independent from server state
+- Move obsolete examples into separated directory
 - Change name of CMake generated C++ library to civetweb-cpp
 - Add option to set linger timeout
 - Update Duktape and Lua (third-party code)

+ 8 - 0
examples/README.md

@@ -0,0 +1,8 @@
+
+Examples
+=====
+
+These examples show how to embed civetweb into a C ([embedded_c](https://github.com/civetweb/civetweb/tree/master/examples/embedded_c)) or a C++ ([embedded_cpp](https://github.com/civetweb/civetweb/tree/master/examples/embedded_cpp)) application.
+The C++ wrapper only offers a subset of the full C API, thus the C example is more complete than the C++ example.
+
+Some no longer maintained examples can be found in the ["obsolete"](https://github.com/civetweb/civetweb/tree/master/examples/_obsolete) folder. It is not guaranteed that they work in the current version - they are kept for reference, but might be removed in the future.