Skip to content

Commit 173195a

Browse files
authored
Build helpers: Create README.md
1 parent bdd043f commit 173195a

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

build-helpers/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## Helpers and other stuff for Build process
2+
3+
Root contents:
4+
- `build-settings.json`: static settings for build process, including version of the dependencies. Used by CMake, Github Workflows and others.
5+
- `ccache.conf`: configuration for ccache. Used by Github Workflows
6+
7+
Folder contents:
8+
- `./cmake`: additional modules for CMake. Used by CMakeLists.txt.
9+
- `./conan`: project's conan recipe. Used by `make` helpers (see below)
10+
- `./debug`: (handcrafted) scripts for build debugging. Run on command line
11+
- `./make`: underlying Python scripts of `make` wrapper - enabling `make deps`, `make <target>`, `make clean` etc. Called by `GNUMakefile` and `make.bat`
12+
- `./wheels`: helpers for wheel building. Called by Github Workflows.

0 commit comments

Comments
 (0)