Add a readme

Author: kerero

README.md

@@ -0,0 +1,42 @@
+# C++ Development Container
+A modern development environment for cmake based C++ projects\
+Pre-configured with the latest tools and vs code extensions
+
+<br>
+
+## Integrating within a project
+From the root of the project
+```
+git submodule add https://github.com/OriKerer/cpp-dev-container.git .devcontainer
+```
+And simply launch the container from the [remote-container extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) with `Remote-Containers: Reopen in container`
+
+<br>
+
+## Using lint & static analysis
+include the cmake script in your `CMakeLists.txt`
+```cmake
+include(/opt/cmake-utils/utils.cmake)
+```
+and use one of the targets:
+- `tidy` / `tidy-fix`
+- `format` / `format-fix`
+- `static-analysis`
+
+<br>
+
+## Package List
+### build tools
+* gcc-11
+* clang-12
+* cmake
+* ninja
+### Debug
+* valgrind
+* gdb
+* rr
+### Code Quality tools
+* clang-[format/tidy/static-analysis]
+* CodeChecker
+### Documentation
+- Doxygen