[Docs] Added note to clarify new glfw3 port (#21272)

emscripten-core · Feb 6, 2024 · 1b2a2ab · 1b2a2ab
1 parent 31e823d
commit 1b2a2ab
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/site/source/docs/compiling/Contrib-Ports.rst b/site/source/docs/compiling/Contrib-Ports.rst
@@ -17,7 +17,16 @@ available in emscripten. In order to use a contrib port you use the
 contrib.glfw3
 =============
 
-This project is an emscripten port of glfw written in C++ for the web/webassembly platform
+This project is an emscripten port of GLFW written in C++ for the
+web/webassembly platform.
+
+.. note::
+  emscripten includes support for both GLFW 2 and 3 written in Javascript.
+  These can be activated with the :ref:`settings <use_glfw>` ``-sUSE_GLFW=2``
+  and ``-sUSE_GLFW=3``. This non-official contribution, written in C++,
+  provides a more extensive and up-to-date implementation of the GLFW 3 API
+  than the built-in port. It is enabled with the option
+  ``--use-port=contrib.glfw3``.
 
 `Project information <https://github.com/pongasoft/emscripten-glfw>`_
 

diff --git a/tools/ports/contrib/glfw3.py b/tools/ports/contrib/glfw3.py
@@ -10,7 +10,7 @@
 
 # contrib port information (required)
 URL = 'https://github.com/pongasoft/emscripten-glfw'
-DESCRIPTION = 'This project is an emscripten port of glfw written in C++ for the web/webassembly platform'
+DESCRIPTION = 'This project is an emscripten port of GLFW written in C++ for the web/webassembly platform'
 LICENSE = 'Apache 2.0 license'