summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-05-12 19:37:03 +1000
committeromniscient <17525998+omnisci3nce@users.noreply.github.com>2024-05-12 19:37:03 +1000
commitd6d83264ff9446f19b8f611f8173812d783a20c2 (patch)
treed383986b9ad340f939b72575a1352645eb80ad65 /docs
parente248c07d4dc894a00d0be3b572fba80db700a91f (diff)
proc Actions
Diffstat (limited to 'docs')
-rw-r--r--docs/getting-started.md7
-rw-r--r--docs/rendering.md1
2 files changed, 8 insertions, 0 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..0baf21c
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,7 @@
+---
+title: Getting up and running
+---
+
+The main build tool we use is [xmake](https://xmake.io/#/getting_started) so installing that is the main prerequisite.
+
+Once that is installed you *should* be able to simply run `xmake build` in the top-level directory. \ No newline at end of file
diff --git a/docs/rendering.md b/docs/rendering.md
new file mode 100644
index 0000000..0081ac5
--- /dev/null
+++ b/docs/rendering.md
@@ -0,0 +1 @@
+# Rendering \ No newline at end of file