From c05b28933ad0710786b89bc853c5618948397518 Mon Sep 17 00:00:00 2001 From: Jacob McDonnell Date: Sat, 28 Feb 2026 15:45:41 -0500 Subject: docs: Include example commands Include a section with example commands and the required files for using this system. --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 4858af1..64a013e 100644 --- a/README.md +++ b/README.md @@ -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) +``` + -- cgit v1.2.3