From 675d75d817d4279b7a8630700d1feb691e4a7e31 Mon Sep 17 00:00:00 2001
From: GeckoEidechse <40122905+GeckoEidechse@users.noreply.github.com>
Date: Thu, 20 Apr 2023 17:58:25 +0200
Subject: docs: Add docs for DevView (#275)

* docs: Add docs for DevView

Contains information about:
- How to access it
- What it's for
- Explanation of certain features

* fix: Update broken image link

* fix: Mention correct number of clicks
on version number

* docs: Mention batch file to run mods PR profile
---
 README.md                           |   2 ++
 docs/DEV-TOOLS.md                   |  28 ++++++++++++++++++++++++++++
 docs/assets/dev-view-screenshot.png | Bin 0 -> 716658 bytes
 3 files changed, 30 insertions(+)
 create mode 100644 docs/DEV-TOOLS.md
 create mode 100644 docs/assets/dev-view-screenshot.png

diff --git a/README.md b/README.md
index 0bd93816..619cce47 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,8 @@ Answers to frequently asked questions can be found in [docs/FAQ.md](docs/FAQ.md)
 
 If you'd like to contribute to FlightCore, see [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md)
 
+If you are a Northstar developer/contributor, you might want to look at [docs/DEV-TOOLS.md](docs/DEV-TOOLS.md)
+
 ## Roadmap
 
 --> See https://github.com/R2NorthstarTools/FlightCore/issues/1
diff --git a/docs/DEV-TOOLS.md b/docs/DEV-TOOLS.md
new file mode 100644
index 00000000..cf880d9d
--- /dev/null
+++ b/docs/DEV-TOOLS.md
@@ -0,0 +1,28 @@
+# Dev tools
+
+![dev view screenshot](assets/dev-view-screenshot.png)
+
+FlightCore features a hidden view that contains development features.
+
+It's targetted at both Northstar and FlightCore contributors. Among other things it contains buttons for unreleased features in FlightCore and tools to help with Northstar development.
+
+To activate it, spam click the FlightCore version number in the settings view at least 6 times. After that a new entry named _DEV_ should appear in the menubar.
+
+## Northstar
+
+### Pull request install
+
+The dev view offers a way to install pull request from the [NorthstarLauncher](https://github.com/R2Northstar/NorthstarLauncher) and [NorthstarMods](https://github.com/R2Northstar/NorthstarMods) repositories.
+
+Launcher pull requests overwrite `NorthstarLauncher.exe` and `Northstar.dll`.
+
+Mod pull requests install into a separate profile called `R2Northstar-PR-test-managed-folder`. \
+When installing a mods PR, FlightCore will place `r2ns-launch-mod-pr-version.bat` into your Titanfall2 directory that can be used to run that PR profile directly. \
+The batch file simply runs `NorthstarLauncher.exe -profile=R2Northstar-PR-test-managed-folder`
+
+
+## FlightCore
+
+The dev view contains various buttons that call functions that might not be fully implemented or tested yet.
+
+Additionally it has some buttons for testing like the _Panic button_ which force crashes the application to test automatic log uploading on crash among other things.
diff --git a/docs/assets/dev-view-screenshot.png b/docs/assets/dev-view-screenshot.png
new file mode 100644
index 00000000..5cf28043
Binary files /dev/null and b/docs/assets/dev-view-screenshot.png differ
-- 
cgit v1.2.3