aboutsummaryrefslogtreecommitdiffstats
path: root/docs/mainpage.dox
diff options
context:
space:
mode:
authorMarcos Magueta <maguetamarcos@gmail.com>2026-06-17 15:49:09 -0300
committerGitHub <noreply@github.com>2026-06-17 15:49:09 -0300
commita4f6637601548a7158869ad155f29db50b151823 (patch)
tree5357cf5639a3981a7fe01c0ac1bbbad572acc5f1 /docs/mainpage.dox
parent5174fc25698cff33b03b5746bf1742e417988f7d (diff)
downloadRNT-a4f6637601548a7158869ad155f29db50b151823.tar.gz
RNT-a4f6637601548a7158869ad155f29db50b151823.zip
License that respects our freedom and GNU stack
Diffstat (limited to 'docs/mainpage.dox')
-rw-r--r--docs/mainpage.dox24
1 files changed, 17 insertions, 7 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.
*/
/**