noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Improve platform-specific READMEs to add useful links

Browse Source 
This also adds READMEs for all platforms.
This commit is contained in:
Hugo Locurcio
2022-08-25 17:50:53 +02:00
parent 0cf0e96038
commit ce56743aa1
7 changed files with 96 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
platform/macos/README.md Normal file
View File

@@ -0,0 +1,19 @@
# macOS platform port
This folder contains the C++, Objective-C and Objective-C++ code for the macOS
platform port.
See also [`misc/dist/macos`](/misc/dist/macos) folder for additional files used
by this platform. [`misc/dist/macos_tools.app`](/misc/dist/macos_tools.app) is
an `.app` bundle template used for packaging the macOS editor, while
[`misc/dist/macos_template.app`](/misc/dist/macos_template.app) is used for
packaging macOS export templates.
## Documentation
- [Compiling for macOS](https://docs.godotengine.org/en/latest/development/compiling/compiling_for_macos.html)
- Instructions on building this platform port from source.
- [Exporting for macOS](https://docs.godotengine.org/en/latest/tutorials/export/exporting_for_macos.html)
- Instructions on using the compiled export templates to export a project.
- [Running Godot apps on macOS](https://docs.godotengine.org/en/latest/tutorials/export/running_on_macos.html)
- Instructions on running Godot projects on macOS.