about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..edd91c2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Victor theme
+
+> To my surprise, no one has created a Hugo theme called Victor
+
+This theme is for general writing, not code documentation.  For documentation,
+you might prefer to use [hugo-book][book] theme, which has support for:
+
+- buttons
+- columns
+- hints
+- KaTeX
+- Mermaid
+- tabs
+
+This theme might be more suitable for prose books rather than documentation.
+
+[book]: https://github.com/alex-shpak/hugo-book
+
+## License
+
+This book theme is released under MIT license.  Full license text can be found in `LICENSES/MIT.txt`.
+
+```
+SPDX-FileCopyrightText: 2022 Ngô Ngọc Đức Huy <huyngo@disroot.org>
+
+SPDX-License-Identifier: MIT
+```
+