summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugen Wissner <belka@caraus.de>2025-05-02 15:26:32 +0200
committerEugen Wissner <belka@caraus.de>2025-05-02 17:05:37 +0200
commit692edeb8e156f842433cd32236d960223ded4ab0 (patch)
treec2e70edbbd6cb0d6713a8ac393cbf5aade6f5daf
parent933f4bb481cab7ba4d27daa2de3b1683e84f0f13 (diff)
downloadkatja-692edeb8e156f842433cd32236d960223ded4ab0.tar.gz
Add a short description and intention
-rw-r--r--CMakeLists.txt4
-rw-r--r--README.md17
-rw-r--r--cli/CMakeLists.txt6
-rw-r--r--cli/component.cpp5
-rw-r--r--cli/component.hpp5
-rw-r--r--cli/main.cpp5
-rw-r--r--cli/page.cpp5
-rw-r--r--cli/page.hpp5
-rw-r--r--tests/CMakeLists.txt4
-rw-r--r--tests/database.cpp5
-rw-r--r--tests/repository.cpp5
11 files changed, 65 insertions, 1 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 129351e..ee00877 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -1,3 +1,7 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
cmake_minimum_required(VERSION 3.21)
project(Katja)
diff --git a/README.md b/README.md
index e2f454d..0ba79b5 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,13 @@
+# 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
@@ -9,3 +19,10 @@ 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.
diff --git a/cli/CMakeLists.txt b/cli/CMakeLists.txt
index 56fc76f..b11226f 100644
--- a/cli/CMakeLists.txt
+++ b/cli/CMakeLists.txt
@@ -1,6 +1,10 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
FetchContent_Declare(ftxui
GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui
- GIT_TAG v6.0.2
+ GIT_TAG v6.1.8
GIT_PROGRESS TRUE
GIT_SHALLOW TRUE
EXCLUDE_FROM_ALL
diff --git a/cli/component.cpp b/cli/component.cpp
index 6218379..0419ad4 100644
--- a/cli/component.cpp
+++ b/cli/component.cpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#include "component.hpp"
#include <sstream>
diff --git a/cli/component.hpp b/cli/component.hpp
index 8ae3e67..a396036 100644
--- a/cli/component.hpp
+++ b/cli/component.hpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#pragma once
#include <optional>
diff --git a/cli/main.cpp b/cli/main.cpp
index b080ca8..ca7a8c5 100644
--- a/cli/main.cpp
+++ b/cli/main.cpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#include <filesystem>
#include <ftxui/component/screen_interactive.hpp>
diff --git a/cli/page.cpp b/cli/page.cpp
index c0e1594..3f83682 100644
--- a/cli/page.cpp
+++ b/cli/page.cpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#include "page.hpp"
#include <algorithm>
diff --git a/cli/page.hpp b/cli/page.hpp
index 66ea8a0..3312d55 100644
--- a/cli/page.hpp
+++ b/cli/page.hpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#pragma once
#include <ftxui/component/event.hpp>
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
index 33ddc98..8276475 100644
--- a/tests/CMakeLists.txt
+++ b/tests/CMakeLists.txt
@@ -1,3 +1,7 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
find_package(Boost CONFIG COMPONENTS unit_test_framework REQUIRED)
file(GLOB KATJA_TEST_SOURCES RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp)
diff --git a/tests/database.cpp b/tests/database.cpp
index d895804..d2651c8 100644
--- a/tests/database.cpp
+++ b/tests/database.cpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#define BOOST_TEST_MODULE database tests
#include <boost/test/unit_test.hpp>
diff --git a/tests/repository.cpp b/tests/repository.cpp
index 1f1fb19..bb1d6c7 100644
--- a/tests/repository.cpp
+++ b/tests/repository.cpp
@@ -1,3 +1,8 @@
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
#define BOOST_TEST_MODULE repository tests
#include <boost/test/unit_test.hpp>