Skip to content

Commit 55a5cca

Browse files
committed
Add a readme
1 parent ef91d9c commit 55a5cca

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# C++ Development Container
2+
A modern development environment for cmake based C++ projects\
3+
Pre-configured with the latest tools and vs code extensions
4+
5+
<br>
6+
7+
## Integrating within a project
8+
From the root of the project
9+
```
10+
git submodule add https://github.com/OriKerer/cpp-dev-container.git .devcontainer
11+
```
12+
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`
13+
14+
<br>
15+
16+
## Using lint & static analysis
17+
include the cmake script in your `CMakeLists.txt`
18+
```cmake
19+
include(/opt/cmake-utils/utils.cmake)
20+
```
21+
and use one of the targets:
22+
- `tidy` / `tidy-fix`
23+
- `format` / `format-fix`
24+
- `static-analysis`
25+
26+
<br>
27+
28+
## Package List
29+
### build tools
30+
* gcc-11
31+
* clang-12
32+
* cmake
33+
* ninja
34+
### Debug
35+
* valgrind
36+
* gdb
37+
* rr
38+
### Code Quality tools
39+
* clang-[format/tidy/static-analysis]
40+
* CodeChecker
41+
### Documentation
42+
- Doxygen

0 commit comments

Comments
 (0)