summaryrefslogtreecommitdiff
path: root/platform/uwp
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2022-08-25 17:50:53 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2022-08-25 17:50:53 +0200
commitce56743aa1b90310ebd036eff8897030c45638b4 (patch)
tree1675730227eae9a6eebec5104de0c246551a6c7e /platform/uwp
parent0cf0e960387620e6a206b5417b25aca008788043 (diff)
Improve platform-specific READMEs to add useful links
This also adds READMEs for all platforms.
Diffstat (limited to 'platform/uwp')
-rw-r--r--platform/uwp/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/platform/uwp/README.md b/platform/uwp/README.md
new file mode 100644
index 0000000000..575f90e3c7
--- /dev/null
+++ b/platform/uwp/README.md
@@ -0,0 +1,20 @@
+# UWP platform port
+
+> **Warning**
+>
+> The UWP platform port is not currently in a working state for the `master`
+> branch, and may be dropped in the future.
+
+This folder contains the C++ code for the Universal Windows Platform (UWP)
+platform port. **This is not to be confused with the "standard" Win32 port**,
+which is available in [`platform/windows`](/platform/windows).
+
+See also [`misc/dist/uwp_template`](/misc/dist/uwp_template) folder for the UWP
+project template used for packaging the UWP export templates.
+
+## Documentation
+
+- [Compiling for Universal Windows Platform](https://docs.godotengine.org/en/latest/development/compiling/compiling_for_uwp.html)
+ - Instructions on building this platform port from source.
+- [Exporting for Universal Windows Platform](https://docs.godotengine.org/en/latest/tutorials/export/exporting_for_uwp.html)
+ - Instructions on using the compiled export templates to export a project.