Add a short description and intention

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)
 

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.

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

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>

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>

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>

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>

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>

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)

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>

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>