aboutsummaryrefslogtreecommitdiff
path: root/doc/building.md
blob: a7feab112f941ffe62447f7813c23892933d7f03 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
## Building from source

### Dependencies
- [Qt](https://www.qt.io/) 6
- [cmake](https://cmake.org/) 3.16 or later
- [kconfiglib](https://github.com/ulfalizer/Kconfiglib/)
- A compiler with C++17 support
- spdlog
- SingleApplication

### Optional dependencies
- openssl or libressl: for signing plugins
- breakpad-client
- gtest

### Steps
```sh
# clone the repository
git clone https://neueland.iserlohn-fortress.net/cgit/smolbote.git
cd smolbote

# Get the submodules
git submodule init
git submodule update

# configure
cmake -S . -B cmake-build

# make
cmake --build cmake-build
```

## Configuring builds
smolbote uses Kconfig to store and customize features and default settings such
as keyboard shortcuts and paths. You can edit these settings using `menuconfig`
from kconfiglib or similar.