summaryrefslogtreecommitdiff
path: root/docs/getting-started.md
diff options
context:
space:
mode:
authorOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
committerOmniscient <omniscient.oce@gmail.com>2024-05-20 10:48:01 +1000
commitc91f86bd744df6f93a93e61d030c55393fb9ef0d (patch)
tree8f8dddade96b420d36489b2f03d0b791628d44aa /docs/getting-started.md
parent5e2186b753c0058253299a651e5752776b88066c (diff)
parent02e84ee4d18e705e3362be1e327fdb6f1397a032 (diff)
Merge branch 'master' into realign
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