Skip to content

Commit

Permalink
Some grammer.
Browse files Browse the repository at this point in the history
  • Loading branch information
mcourteaux committed Oct 5, 2024
1 parent 51d7e8f commit c1a60e8
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,8 @@ Build
-----

bgfx uses `GENie - Project generator tool <https://github.com/bkaradzic/genie#genie---project-generator-tool>`__
to generate project files for various platform. Binaries for Linux, macOS, and Windows are included in
bx repository. GENie can generate a useful list of options relevant to the project using the
to generate project files for various platforms. Binaries of GENie for Linux, macOS, and Windows are included in
the bx repository. GENie can generate a useful list of options relevant to the project using the
``--help`` flag. Most platform-specific examples below do not explicitly use the ``genie`` executable, but a convenience
makefile instead. For more control, you can directly use ``genie`` to generate the project files.

Expand All @@ -95,9 +95,9 @@ General (Makefile wrapper)
cd bgfx
make

After calling ``make``, ``.build/projects/\*`` directory will be generated.
All intermediate files generated by compiler will be inside .build
directory structure. Deleting .build directory at any time is safe.
After calling ``make``, some directories in ``.build/projects/\*`` will be generated.
All intermediate files, libraries and executables generated by the compiler will be inside this
``.build`` directory structure. Deleting ``.build`` directory at any time is safe.

::

Expand All @@ -113,7 +113,7 @@ Configuration is ``<platform>-<debug/release>[32/64]``. For example:
General (Directly with GENie)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Inspect the available options (where ``<platform>`` is ``linux``, ``windows``, or ``darwin``):
Inspect the available options by invoking GENie with the ``--help`` option (where ``<platform>`` is ``linux``, ``windows``, or ``darwin``):
::

../bx/tools/bin/<platform>/genie --help
Expand Down Expand Up @@ -193,7 +193,7 @@ Or for Xcode IDE:
../bx/tools/bin/darwin/genie --with-combined-examples --xcode=osx xcode9
open .build/projects/xcode9-osx/bgfx.xcworkspace

Due to `inability <https://github.com/bkaradzic/genie/blob/master/docs/scripting-reference.md#debugdirpath>`__
Due to the `inability <https://github.com/bkaradzic/genie/blob/master/docs/scripting-reference.md#debugdirpath>`__
to set working directory for an Xcode project from `GENie <https://github.com/bkaradzic/genie#genie---project-generator-tool>`__
configuration file, it has to be set manually for each example project:

Expand Down Expand Up @@ -227,12 +227,12 @@ Build the resulting solution and deploy to device.
Amalgamated Build
-----------------

For ease of integration to other build system bgfx library can be built
with single .cpp file. It's only necessary to build
For ease of integration with other build systems, the bgfx library can be built
with a single .cpp file. It's only necessary to build
`src/amalgamated.cpp <https://github.com/bkaradzic/bgfx/blob/master/src/amalgamated.cpp>`__
(for macOS/iOS/iPadOS/tvOS use
`src/amalgamated.mm <https://github.com/bkaradzic/bgfx/blob/master/src/amalgamated.mm>`__
instead) inside different build system.
instead) inside a different build system.

Tools
-----
Expand Down

0 comments on commit c1a60e8

Please sign in to comment.