aboutsummaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..a161a76
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,33 @@
+---
+description: A Titanfall|2 mod to join and host custom servers.
+---
+
+# Welcome to Northstar
+
+Welcome to the Northstar wiki!
+
+Get the newest Northstar release here:
+
+{% embed url="https://github.com/R2Northstar/Northstar/releases" %}
+
+Install instructions can be found here:
+
+{% content-ref url="installing-northstar/basic-setup.md" %}
+[basic-setup.md](installing-northstar/basic-setup.md)
+{% endcontent-ref %}
+
+For modding guides, documentation on Northstar API features and documentation on Respawn Squirrel look at:
+
+{% content-ref url="modding/getting-started.md" %}
+[getting-started.md](modding/getting-started.md)
+{% endcontent-ref %}
+
+**Please remember:** You should expect to encounter bugs and crashes with Northstar.\
+Northstar is mostly being developed by a single person as a mod to Titanfall|2.\
+If you do encounter issues that this guide doesn't have a fix for, you can get support in the Discord linked below.
+
+{% embed url="https://northstar.tf/discord" %}
+
+All the source code related to Northstar can be found here:
+
+{% embed url="https://northstar.tf" %}