From 1457c0c956792e9ca3efa5bcfdee75e294fd5475 Mon Sep 17 00:00:00 2001 From: Yan Pujante Date: Tue, 6 Feb 2024 05:54:04 -0800 Subject: [PATCH 1/2] added note --- site/source/docs/compiling/Contrib-Ports.rst | 11 ++++++++++- tools/ports/contrib/glfw3.py | 2 +- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/site/source/docs/compiling/Contrib-Ports.rst b/site/source/docs/compiling/Contrib-Ports.rst index 00b649761c9c0..c5ba7b0681ab9 100644 --- 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 ` ``-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 in-built port. It is enabled with the option + ``--use-port=contrib.glfw3``. `Project information `_ diff --git a/tools/ports/contrib/glfw3.py b/tools/ports/contrib/glfw3.py index b15cf6c38c944..60caa4231620d 100644 --- 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' From a6cdd59e3d546f0974374f745a007f5257e47496 Mon Sep 17 00:00:00 2001 From: Yan Pujante Date: Tue, 6 Feb 2024 07:18:55 -0800 Subject: [PATCH 2/2] fixed typo --- site/source/docs/compiling/Contrib-Ports.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/site/source/docs/compiling/Contrib-Ports.rst b/site/source/docs/compiling/Contrib-Ports.rst index c5ba7b0681ab9..e387428c5c774 100644 --- a/site/source/docs/compiling/Contrib-Ports.rst +++ b/site/source/docs/compiling/Contrib-Ports.rst @@ -25,7 +25,7 @@ web/webassembly platform. These can be activated with the :ref:`settings ` ``-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 in-built port. It is enabled with the option + than the built-in port. It is enabled with the option ``--use-port=contrib.glfw3``. `Project information `_