File tree Expand file tree Collapse file tree 4 files changed +60
-3
lines changed
Expand file tree Collapse file tree 4 files changed +60
-3
lines changed Original file line number Diff line number Diff line change @@ -31,6 +31,17 @@ one repository. This reposiutory can then be added as a Git submodule to
3131multiple repositories that will then benefit from the same tools and
3232configurations.
3333
34+ ## Requirements
35+
36+ The following programs must be installed before using the tools provided by the
37+ repository.
38+
39+ - [ cmake-format] ( https://github.com/cheshirekow/cmake_format )
40+ - [ cmake-lint] ( https://github.com/cheshirekow/cmake_format )
41+ - [ clang-format] ( https://github.com/llvm-mirror/clang/tree/master/tools/clang-format )
42+
43+ An example of how to install these programs is given in this [ Dockerfile] ( https://github.com/tschaffter/cxx-ci.git )
44+
3445## Usage
3546
3647If you want to use the tool versions and configurations defined in this
@@ -123,14 +134,23 @@ in this repository. The CML interface is the same as `cxxdt-cmake-lint`.
123134
124135## GitHub tools
125136
126- - [ pre-commit hook ] ( git/.githooks /pre-commit) - Checks
127- that your ` .circleci/config.yml ` is valid, otherwise ` git commit` fails .
137+ - .githook /pre-commit - Validates ` .circleci/config.yml `
138+ before acceptiing a commit.
128139
129140## Continuous Integration
130141
131142An example of integration of ` cxx-dev-tools ` into a CI configuration is
132143available in ` .circleci/config.yml ` .
133144
145+ ## Related Open Source Projects
146+
147+ Projects | Description
148+ ----------|--------------|
149+ [ tschaffter/cxx-ci] ( https://github.com/tschaffter/cxx-ci.git ) | CXX build and test environment
150+ [ tschaffter/cxx-ci] ( https://github.com/tschaffter/esp-idf-ci.git ) | ESP-IDF build and test environment
151+
152+ [ tschaffter/cxx-ci -
153+
134154## Contributing change
135155
136156Please read the [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) for details on how to contribute to this project.
Original file line number Diff line number Diff line change 1+ # Developing with CMake
2+
3+ ## Tools
4+
5+ - cxxdt-cmake-lint
6+ - cxxdt-cmake-format
7+
8+ These tools use the following configurations:
9+
10+ - config/.cmake-format.json - Default configuration generated using ` cmake-format ` .
11+ - config/.esp-idf-cmake-format.json - Configuration for linting ESP-IDF CMake
12+ files.
13+
14+ See the project [ README.md] ( ../README.md ) for more detailed information on how
15+ to use these tools.
16+
17+ ## CMake modules
18+
19+ - BuildType.cmake - Set a default build type if none was specified.
Original file line number Diff line number Diff line change 1+ # CXX Development
2+
3+ ## Tools
4+
5+ - cxxdt-cxx-lint
6+ - cxxdt-cxx-format
7+
8+ These tools use the following configuration:
9+
10+ - config/.clang-format
11+
12+ See the project [ README.md] ( ../README.md ) for more detailed information on how
13+ to use these tools.
Original file line number Diff line number Diff line change 1- ## Set Git hooks directory
1+ # Developing with Git
2+
3+ ## Git hooks
4+
5+ - .githooks/pre-commit - Validates ` .circleci/config.yml ` before acceptiing a
6+ commit.
27
38```
49git config core.hooksPath .githooks
You can’t perform that action at this time.
0 commit comments