Skip to content

Commit e42d14b

Browse files
authored
Docs: improve writings on docs/getting_started (#24014)
- Change "Windows 8" to just "Windows" - Change "start screen" to "start menu" (as it's more common in many versions of Windows) - Improve grammar - Fix typo
1 parent 920fa00 commit e42d14b

File tree

4 files changed

+24
-33
lines changed

4 files changed

+24
-33
lines changed

site/source/docs/getting_started/FAQ.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Why do I get errors building basic code and the tests?
1818

1919
All the tests in the :ref:`Emscripten test suite <emscripten-test-suite>` are
2020
known to build and pass on our test infrastructure, so if you see failures
21-
locally it is likely that there is some problem with your environment. (Rarely,
21+
locally, it is likely that there is some problem with your environment. (Rarely,
2222
there may be temporary breakage, but never on a tagged release version.)
2323

2424
First call ``emcc --check``, which runs basic sanity checks and prints out
@@ -105,13 +105,13 @@ compilation time).
105105
Why is my compiled code big?
106106
============================
107107

108-
Make sure you build with ``-O3`` or ``-Os`` so code is fully optimized and
108+
Make sure you build with ``-O3`` or ``-Os``, so the code is fully optimized and
109109
minified. You should use the closure compiler, gzip compression on your
110110
webserver, etc., see the :ref:`section on code size in Optimizing code
111111
<optimizing-code-size>`.
112112

113113

114-
Why does compiling code that works on another machine gives me errors?
114+
Why does compiling code that works on another machine give me errors?
115115
======================================================================
116116

117117
Make sure you are using the Emscripten bundled system headers. Using :ref:`emcc
@@ -207,11 +207,11 @@ JavaScript that does not complete and return control to the browser.
207207
Graphical C++ apps typically have an infinite main loop in which event handling,
208208
processing and rendering is done, followed by a delay to keep the frame-rate
209209
right (``SDL_DELAY`` in :term:`SDL` apps). As the main loop does not complete
210-
(is infinite) it cannot return control to the browser, and the app will hang.
210+
(is infinite), it cannot return control to the browser, and the app will hang.
211211

212212
Apps that use an infinite main loop should be re-coded to put the actions for a
213213
single iteration of the loop into a single "finite" function. In the native
214-
build this function can be run in an infinite loop as before. In the Emscripten
214+
build, this function can be run in an infinite loop as before. In the Emscripten
215215
build it is set as the :ref:`main loop function <faq-how-run-event-loop>` and
216216
will be called by the browser at a specified frequency.
217217

site/source/docs/getting_started/Tutorial.rst

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,18 @@ using ``./emcc`` or ``./em++``.
2828
For the next section you will need to open a command prompt:
2929

3030
- On Linux or macOS, open a *Terminal*.
31-
- On Windows open the :ref:`Emscripten Command Prompt <emcmdprompt>`, a command
31+
- On Windows, open the :ref:`Emscripten Command Prompt <emcmdprompt>`, a command
3232
prompt that has been pre-configured with the correct system paths and settings
3333
to point to the :term:`active <Active Tool/SDK>` Emscripten tools. To access
34-
this prompt, type **Emscripten** in the Windows 8 start screen, and then
34+
this prompt, type **Emscripten** in the Windows start menu, and then
3535
select the **Emscripten Command Prompt** option.
3636

3737
Navigate with the command prompt to the emscripten directory under the SDK. This
3838
is a folder below the :term:`emsdk root directory`, typically
3939
**<emsdk root directory>/upstream/emscripten/**.
4040
The examples below will depend on finding files relative to that location.
4141

42-
.. note:: In older emscripten versions the directory structure was different:
42+
.. note:: In older emscripten versions, the directory structure was different:
4343
the version number appeared, and the backend (fastcomp/upstream) did not, so
4444
you would use something like **<emsdk root directory>/emscripten/1.20.0/**.
4545

@@ -52,7 +52,7 @@ If you haven't run Emscripten before, run it now with: ::
5252
./emcc -v
5353

5454
If the output contains warnings about missing tools, see
55-
:ref:`verifying-the-emscripten-environment` for debugging help. Otherwise
55+
:ref:`verifying-the-emscripten-environment` for debugging help. Otherwise,
5656
continue to the next sections where we'll build some code.
5757

5858

@@ -61,7 +61,7 @@ Running Emscripten
6161

6262
You can now compile your first C/C++ file to JavaScript.
6363

64-
First, lets have a look at the file to be compiled: **hello_world.c**. This is
64+
First, let's have a look at the file to be compiled: **hello_world.c**. This is
6565
the simplest test code in the SDK, and as you can see, all it does is print
6666
"hello, world!" to the console and then exit.
6767

@@ -86,15 +86,6 @@ execute it. You can run them using :term:`node.js`:
8686

8787
This prints "hello, world!" to the console, as expected.
8888

89-
.. note:: Older node.js versions do not have WebAssembly support yet. In that
90-
case you will see an error message suggesting that you build with
91-
``-sWASM=0`` to disable WebAssembly, and then emscripten will emit the compiled
92-
code as JavaScript. In general, WebAssembly is recommended as it has
93-
widespread browser support and is more efficient both to execute and to
94-
download (and therefore emscripten emits it by default), but sometimes you
95-
may need your code to run in an environment where it is not yet present and
96-
so should disable it.
97-
9889
.. tip:: If an error occurs when calling *emcc*, run it with the ``-v`` option
9990
to print out a lot of useful debug information.
10091

@@ -116,11 +107,11 @@ file as the target file: ::
116107

117108
You can now open ``hello.html`` in a web browser.
118109

119-
.. note:: Unfortunately several browsers (including *Chrome*, *Safari*, and
120-
*Internet Explorer*) do not support ``file://`` :term:`XHR` requests, and
121-
can't load extra files needed by the HTML (like a ``.wasm`` file, or packaged
122-
file data as mentioned lower down). For these browsers you'll need to serve
123-
the files using a :ref:`local webserver <faq-local-webserver>` and then open
110+
.. note:: Unfortunately, several browsers (including *Chrome* and *Safari*) do
111+
not support ``file://`` :term:`XHR` requests, and can't load extra files
112+
needed by the HTML (like a ``.wasm`` file, or packaged file data as mentioned
113+
lower down). For these browsers, you'll need to serve the files using a
114+
:ref:`local webserver <faq-local-webserver>` and then open
124115
``http://localhost:8000/hello.html``).
125116

126117
Once you have the HTML loaded in your browser, you'll see a text area for

site/source/docs/getting_started/downloads.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ Download and install
88
<installing-from-source>` if you prefer that to downloading binaries using
99
the emsdk.
1010

11-
.. tip:: if you'd like to install emscripten using the **unofficial** packages
11+
.. tip:: If you'd like to install emscripten using the **unofficial** packages
1212
instead of the **officially supported** emsdk, see the bottom of the page.
1313

1414
.. _sdk-installation-instructions:
1515

1616
Installation instructions using the emsdk (recommended)
1717
=======================================================
1818

19-
First check the :ref:`Platform-specific notes
19+
First, check the :ref:`Platform-specific notes
2020
<platform-notes-installation_instructions-SDK>` below and install any
2121
prerequisites.
2222

2323
The core Emscripten SDK (emsdk) driver is a Python script. You can get it for
24-
the first time with
24+
the first time with:
2525

2626
::
2727

@@ -52,7 +52,7 @@ GitHub and set them as :term:`active <Active Tool/SDK>`:
5252
# Activate PATH and other environment variables in the current terminal
5353
source ./emsdk_env.sh
5454

55-
.. tip:: If you want to avoid executing `source ./emsdk_env.sh` every time you open a new terminal you can follow the instructions given by the `emsdk activate` command above to add this command to your startup scripts.
55+
.. tip:: If you want to avoid executing `source ./emsdk_env.sh` every time you open a new terminal, you can follow the instructions given by the `emsdk activate` command above to add this command to your startup scripts.
5656

5757
.. note:: On Windows, run ``emsdk.bat`` instead of ``./emsdk``, and ``emsdk_env.bat`` instead of ``source ./emsdk_env.sh``.
5858

@@ -67,7 +67,7 @@ commands.
6767
Emsdk install targets
6868
---------------------
6969

70-
In the description above we asked the emsdk to install and activate ``latest``,
70+
In the description above, we asked the emsdk to install and activate ``latest``,
7171
which is the latest tagged release. That is often what you want.
7272

7373
You can also install a specific version by specifying it, for example,
@@ -101,7 +101,7 @@ target, and note that you must specify the backend explicitly,
101101
# Get a tip-of-tree
102102
./emsdk install tot
103103

104-
(In the above examples we installed the various targets; remember to also
104+
(In the above examples, we installed the various targets; remember to also
105105
``activate`` them as in the full example from earlier.)
106106

107107
.. _platform-notes-installation_instructions-SDK:
@@ -122,8 +122,8 @@ macOS
122122

123123
.. note:: Emscripten requires macOS 10.14 Mojave or above.
124124

125-
If you use the Emscripten SDK it includes a bundled version of Python 3.
126-
Otherwise you will need to manually install and use Python 3.6 or newer.
125+
If you use the Emscripten SDK, it includes a bundled version of Python 3.
126+
Otherwise, you will need to manually install and use Python 3.6 or newer.
127127

128128
These instructions explain how to install **all** the :ref:`required tools
129129
<toolchain-what-you-need>`. You can :ref:`test whether some of these are already

site/source/docs/getting_started/test-suite.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ the first failure.
9999
that are normally run in parallel you can force them to run serially using
100100
``-j1``.
101101

102-
One a test is fixed you continue where you left off using ``--start-at`` option:
102+
Once a test is fixed, you continue where you left off using ``--start-at`` option:
103103

104104
.. code-block:: bash
105105

0 commit comments

Comments
 (0)