]> O.S.I.I.S - jp/vkvg.git/commitdiff
Update windows_build_tutorial.md
authorJoão Oliveira <44142506+Joaopmoliveira@users.noreply.github.com>
Tue, 5 May 2020 09:37:06 +0000 (10:37 +0100)
committerGitHub <noreply@github.com>
Tue, 5 May 2020 09:37:06 +0000 (10:37 +0100)
doc/windows_build_tutorial.md

index 7923320c37beceb637e548ad6c779b09f31c7a7e..4971237a286f47e324f9f555910b07c36f0b2f61 100644 (file)
@@ -16,13 +16,13 @@ git version 2.19.1.windows.1
 \r
 Then git is installed on your machine. If an error is given, then [install git on your machine](https://git-scm.com/download/win).<br> \r
 \r
-2 - To install all the dependencies one can use a packadge manager to simplify the required steps. The [vcpkg package manager](https://docs.microsoft.com/en-us/cpp/build/vcpkg?view=vs-2019) allows one to link projects with a large array of libraries already developed in C\C++. The instalation of vcpkg is trivial. First open a command line and write: <br>\r
+2 - To install all the dependencies one can use a packadge manager to simplify the required steps. The [vcpkg package manager](https://docs.microsoft.com/en-us/cpp/build/vcpkg?view=vs-2019) allows one to link projects with a large array of libraries already developed in C\C++. The instalation of **vcpkg** is trivial. First open a command line and write: <br>\r
 ```bash\r
 > git clone https://github.com/Microsoft/vcpkg.git\r
 > cd vcpkg\r
 > .\bootstrap-vcpkg.bat\r
 ```\r
-3 - The dependencies required by vkvg are :<br> \r
+3 - The dependencies required by **vkvg** are :<br> \r
 \r
 - [CMake](https://cmake.org/) -> Used to define projects across several operating systems (OS)<br>\r
 - [Vulkan](https://www.khronos.org/vulkan/) -> The API to interact with the GPU to create images which you are already probabily familiar<br>\r
@@ -31,7 +31,7 @@ Then git is installed on your machine. If an error is given, then [install git o
 - [Harfbuzz](https://www.freedesktop.org/wiki/Software/HarfBuzz/) -> Library used to shape the text .<br>\r
 - [GLFW](http://www.glfw.org/) -> Library used to create a window independent from the underlying OS<br>\r
 \r
-To install all these libraries write on the cmd (assuming you are still on vcpkg directory):<br>\r
+To install all these libraries write on the cmd (assuming you are still on **vcpkg** directory):<br>\r
 ```bash\r
 > vcpkg search vulkan\r
 ```\r
@@ -51,17 +51,17 @@ And do the same drill for all the other libraries...<br>
 \r
 With the previous commands the source files from the open sourced project is now on the machine and they have been compiled with MSVN so that no incompatibilities emerge further down the line.\r
 \r
-5 - To download the vkvg library type:<br>\r
+5 - To download the **vkvg** library type:<br>\r
 ```bash\r
 > cd ..\r
 ```\r
-On the command line to get out of the vcpkg directory and then write:<br>\r
+On the command line to get out of the **vcpkg** directory and then write:<br>\r
 ```bash\r
 > git clone https://github.com/jpbruyere/vkvg.git\r
 ```\r
 To download the code to a local repository<br>\r
 \r
-6 - Now we can use the IDE from CMake to generate the .sln file which can be processed by visual studio. Open the IDE and select the directory which contains the source code (it should be something like <i>'C:\...\vkvg'</i>). Now select the folder where you want to generate the project to. In our case we created a folder called bin (<i>'C:\...\vkvg\bin'</i>) and selected that file.<br>\r
+6 - To generate the .sln file which can be processed by visual studio go to the CMake IDE and lauch it. Select the directory which contains the source code (it should be something like <i>'C:\...\vkvg'</i>). Now select the folder where you want to generate the project to. For this test build try creating the directory <i>'C:\...\vkvg\bin'</i> and selected that file.<br>\r
 \r
 7 - Now configure the project. This action generated a window where you can select the target build you want, in our case it is <i>Visual Studio 15 2017 Win64</i> and we must specify the toolchain file for cross-compiling (because it is the vcpkg program which knowns where all the libraries we previously downloaded currently are). It should be a file located in <i>'C:\...\vcpkg\scripts\buildsystems\vcpkg.cmake'</i> which contains information to be used by cmake.<br>\r
 \r