Skip to content

Commit 0ecaf03

Browse files
committed
Update README.md
1 parent 40c62b0 commit 0ecaf03

File tree

4 files changed

+60
-3
lines changed

4 files changed

+60
-3
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ one repository. This reposiutory can then be added as a Git submodule to
3131
multiple repositories that will then benefit from the same tools and
3232
configurations.
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

3647
If 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

131142
An example of integration of `cxx-dev-tools` into a CI configuration is
132143
available 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

136156
Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on how to contribute to this project.

cmake/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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.

cxx/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
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.

git/README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
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
```
49
git config core.hooksPath .githooks

0 commit comments

Comments
 (0)