Browse Source

doc: improve Getting Started instructions.

pull/175/merge
Vladimír Vondruš 10 years ago
parent
commit
51658cb9dd
  1. 10
      doc/getting-started.dox

10
doc/getting-started.dox

@ -163,8 +163,8 @@ In the following tutorials the code will be explained more thoroughly.
In Linux (and other Unix-based OSs) you can build the application along with In Linux (and other Unix-based OSs) you can build the application along with
the subprojects using the following three commands: create out-of-source build the subprojects using the following three commands: create out-of-source build
directory, run cmake, enable SDL2 application in the Magnum subproject and then directory, run cmake, enable SDL2 application in the Magnum subproject and then
build the everything. The compiled application binary will then appear in src/ build everything. The compiled application binary will then appear in `src/`
subdirectory of build dir: subdirectory of the build dir:
mkdir -p build && cd build mkdir -p build && cd build
cmake .. -DWITH_SDL2APPLICATION=ON cmake .. -DWITH_SDL2APPLICATION=ON
@ -176,8 +176,7 @@ whether you will use command-line, QtCreator or Visual Studio. With Visual
Studio the most straightforward way to create the project file is via the Studio the most straightforward way to create the project file is via the
command-line: command-line:
mkdir build mkdir build && cd build
cd build
cmake .. -DWITH_SDL2APPLICATION=ON cmake .. -DWITH_SDL2APPLICATION=ON
You can also use CMake GUI. Then open the `MyApplication.sln` project file You can also use CMake GUI. Then open the `MyApplication.sln` project file
@ -199,7 +198,8 @@ On Windows you may get errors about missing DLLs when running the application.
The solution is either compiling everything as static (enable `BUILD_STATIC` The solution is either compiling everything as static (enable `BUILD_STATIC`
CMake option) or installing the dependencies somewhere. To install them, change CMake option) or installing the dependencies somewhere. To install them, change
`CMAKE_INSTALL_PREFIX` to your liking and run the `install` target. Then run `CMAKE_INSTALL_PREFIX` to your liking and run the `install` target. Then run
the application with `bin/` subdirectory of installation prefix as working dir. the application with `bin/` subdirectory of installation prefix as working dir
or add the `bin/` subdirectory to `PATH`.
@image html getting-started.png @image html getting-started.png
@image latex getting-started.png @image latex getting-started.png

Loading…
Cancel
Save