summaryrefslogtreecommitdiff
path: root/docs/getting-started.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/getting-started.md')
-rw-r--r--docs/getting-started.md7
1 files changed, 7 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