diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-02-28 15:45:41 -0500 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-02-28 15:45:41 -0500 |
| commit | c05b28933ad0710786b89bc853c5618948397518 (patch) | |
| tree | 727a5b4789484d9ca81f14552bdafb5987bb8469 /README.md | |
| parent | 612fd7b29cde5382fda720d76347212442ea4eec (diff) | |
docs: Include example commands
Include a section with example commands and the required files for using
this system.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
@@ -2,3 +2,32 @@ The goal of this project is to integrate Kconfiglib into CMake in a clean way. +## Example + +### Required Directories/Files + +``` +. +├── cmake +│ ├── Kconfig.cmake +├── CMakeLists.txt +├── configs +│ ├── example_defconfig +│ └── example2_defconfig +├── Kconfig +└── tools + ├── Kconfiglib/ + └── make-cmake-config +``` + +### Commands + +``` +mkdir build +cd build +cmake -DDEFCONFIG=example_defconfig [-G Ninja] .. +(make | ninja) menuconfig +[(make | ninja) savedefconfig] +(make | ninja) +``` + |
