aboutsummaryrefslogtreecommitdiff
path: root/doc/mainpage.md
diff options
context:
space:
mode:
authorClément Zrounba <6691770+clement-z@users.noreply.github.com>2023-09-30 23:06:01 +0200
committerClément Zrounba <6691770+clement-z@users.noreply.github.com>2023-09-30 23:26:46 +0200
commitff9b8bb838ecdfbfc1dc81038fcf3b2a87636982 (patch)
tree21f27be782ce11c6d00b96ce100a2bff88141b2e /doc/mainpage.md
downloadspecs-ff9b8bb838ecdfbfc1dc81038fcf3b2a87636982.tar.gz
specs-ff9b8bb838ecdfbfc1dc81038fcf3b2a87636982.zip
Initial release
Diffstat (limited to 'doc/mainpage.md')
-rw-r--r--doc/mainpage.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/mainpage.md b/doc/mainpage.md
new file mode 100644
index 0000000..f980c5c
--- /dev/null
+++ b/doc/mainpage.md
@@ -0,0 +1,14 @@
+# SPECS
+
+## Introduction
+
+TODO
+
+## This documentation
+
+For now, you can have a look at:
+
+* [**Readme**](readme.html) to get some general information about the project
+* [**Quickstart**](quickstart.html) to get started (building and running the code)
+
+And refer the auto-generated code documentation.