diff options
Diffstat (limited to 'doc/Building.asciidoc')
| -rw-r--r-- | doc/Building.asciidoc | 33 |
1 files changed, 10 insertions, 23 deletions
diff --git a/doc/Building.asciidoc b/doc/Building.asciidoc index f1927de..fc7cc89 100644 --- a/doc/Building.asciidoc +++ b/doc/Building.asciidoc @@ -15,15 +15,11 @@ | link:https://mesonbuild.com/[meson] | Version 0.48 -| +| Requires python3 and ninja -| ninja -| -| Requirement of meson - -| python3 -| -| Requirement both of meson, and some scripts in tools/ +| link:https://github.com/ulfalizer/Kconfiglib[Kconfiglib] +| Version 10.22.1 +| Available on PyPI with 'pip install kconfiglib' | A compiler | C++17 support @@ -36,9 +32,6 @@ |=== == Building from source -In short, the generic cmake build loop of 'cmake, make, make install' will -generate a makefile, build the program and install it. - [source, sh] ---- # clone the repository @@ -58,23 +51,17 @@ meson build ninja ---- +Run `meson configure` in the build directory to list available options. +For more information on how to use meson, see the meson link:https://mesonbuild.com/Quick-guide.html[quick guide]. + === Configuring smolbote smolbote uses Kconfig to store and customize default application settings such -as keyboard shortcuts and paths. You can edit these settings by running -`tools/Kconfiglib/menuconfig.py` in the repository root. +as keyboard shortcuts and paths. You can edit these settings using 'menuconfig' +in the repository root. -When building, tools/config.py is used to load `platform-name/.config` and +When building, tools/config.py is used to load `$platform-name/.config` and generate a header file. -=== Configuring meson -Run `meson configure` in the build directory to list available options. - -Use `meson configure -Doption=value` change them. Ninja will regenerate its -build file on next run. - -See the link:https://mesonbuild.com/Quick-guide.html[meson documentation] for -more information on how to use meson. - // Compiling on Windows include::Building/Windows.asciidoc[] |