diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/mainpage.dox | 24 | ||||
| -rw-r--r-- | docs/reactos-ob-comparison.md | 2 |
2 files changed, 18 insertions, 8 deletions
diff --git a/docs/mainpage.dox b/docs/mainpage.dox index 3c6daa3..8cef183 100644 --- a/docs/mainpage.dox +++ b/docs/mainpage.dox @@ -1,9 +1,10 @@ /** - * @mainpage Relational NT + * @mainpage RNT * * @image html logo.png + * <p><a href="https://www.gnu.org/licenses/agpl-3.0.html"><img src="https://www.gnu.org/graphics/agplv3-with-text-162x68.png" alt="GNU AGPLv3" /></a></p> * - * Relational NT is an experimental database kernel inspired by the + * RNT is an experimental database kernel inspired by the * object-management model of the Windows NT kernel. The project applies * explicit object management to database state: relations, tuples, * transactions, namespaces, permissions, cursors, and handles are @@ -55,15 +56,16 @@ * * @section building Building * - * Requires MSVC, CMake 3.10 or later, and vcpkg. Dependencies are fetched - * automatically during configure. + * Requires the Nix development shell on GNU/Linux. The flake provides GCC, + * CMake, Ninja, SQLite, PicoSHA2 headers, Catch2, Doxygen, and Graphviz. * * @code{.sh} - * cmake --preset x64-debug - * cmake --build out/build/x64-debug + * nix develop + * cmake --preset gnu-debug + * cmake --build out/build/gnu-debug * @endcode * - * A release build uses @c --preset @c x64-release. + * A release build uses @c --preset @c gnu-release. * * @section docs Generating Documentation * @@ -72,6 +74,14 @@ * @endcode * * Generated HTML is written to @c docs/generated/html. + * + * @section license License + * + * RNT is free software licensed under the GNU Affero General Public License + * v3.0. See the repository @c LICENSE file for the full terms. + * + * Copyright (C) 2026 Marcos Magueta, RNT contributors, and Don't Rely on + * Nulls. Maintainer: Marcos Magueta. */ /** diff --git a/docs/reactos-ob-comparison.md b/docs/reactos-ob-comparison.md index 94d3081..2f0a391 100644 --- a/docs/reactos-ob-comparison.md +++ b/docs/reactos-ob-comparison.md @@ -106,7 +106,7 @@ segment string to child `registry*`. This matches the ReactOS structure naturall because `object_path` is already a `std::vector<std::string>`. Rather than implementing the trie from scratch, consider pulling a suitable -container via vcpkg (e.g. a radix tree or a well-tested associative structure). +container via the Nix flake (e.g. a radix tree or a well-tested associative structure). The only hard requirement is that each directory level supports O(1) average lookup by segment name and ordered iteration for namespace enumeration. |