diff options
Diffstat (limited to 'platform/web/README.md')
| -rw-r--r-- | platform/web/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/platform/web/README.md b/platform/web/README.md new file mode 100644 index 0000000000..1265ca09df --- /dev/null +++ b/platform/web/README.md @@ -0,0 +1,22 @@ +# Web platform port + +This folder contains the C++ and JavaScript code for the Web platform port, +compiled using [Emscripten](https://emscripten.org/). + +It also contains a ESLint linting setup (see [`package.json`](package.json)). + +See also [`misc/dist/html`](/misc/dist/html) folder for additional files used by +this platform such as the html shell (web page). + +## Documentation + +- [Compiling for the Web](https://docs.godotengine.org/en/latest/development/compiling/compiling_for_web.html) + - Instructions on building this platform port from source. +- [Exporting for the Web](https://docs.godotengine.org/en/latest/tutorials/export/exporting_for_web.html) + - Instructions on using the compiled export templates to export a project. + +## Artwork license + +[`logo.png`](logo.png) and [`run_icon.png`](run_icon.png) are licensed under +[Creative Commons Attribution 3.0 Unported](https://www.w3.org/html/logo/faq.html#how-licenced) +per the HTML5 logo usage guidelines. |