katja/README.md

29 lines
873 B
Markdown

# katja
This is an ongoing effort to create a package management library
for Slackware Linux. The purpose of the library is to provide an
interface between different kinds of Slackware repository formats
and console or graphical user interfaces.
To test the functionality there is also a text user interface
implementation, that exposes the library to a user.
## Build instructions
```sh
cmake -B build
make -C build
```
Pass `-DCMAKE_BUILD_TYPE=Debug` or `-DCMAKE_BUILD_TYPE=Release` to
`cmake` to select the according build configuration.
This builds a CLI that can be then found in `./build/bin/katja`.
## Project structure
The library code is in `katja/`. Public headers are under `include/`.
Finally the optional UI implementation is under `cli/`. There are
also some tests in the appropriate directory. There are
also some tests in the appropriate directory.