diff --git a/README.md b/README.md new file mode 100644 index 0000000..25c645c --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# webcxx + +A simple web framework similar to Flask, but for C++. + +## Warning +This project is in super-alpha state and should not be used in production. It's probably filled with bugs and security vulnerabilities. You have been warned. + +## How to use +See [webcxx-example](https://git.cloudapio.eu/apio/webcxx-example). + +## How to add webcxx into your project (with CMake) +Add this repo as a submodule. + +Append the following lines into your CMakeLists.txt: + +``` +include(webcxx/CMakeLists.txt) + +target_include_directories( PUBLIC ${webcxx_include}) +target_link_libraries( PUBLIC ${webcxx_libs}) +``` \ No newline at end of file