]> O.S.I.I.S - jp/vkvg.git/commitdiff
Update README.md
authorj-p <jp.bruyere@live.be>
Sun, 15 Apr 2018 03:06:18 +0000 (05:06 +0200)
committerGitHub <noreply@github.com>
Sun, 15 Apr 2018 03:06:18 +0000 (05:06 +0200)
README.md

index c06dd219b59043c1d810b0fdae5f0c050ffafdab..3b4ccbd9563b0f32cece781c9a079ea261ec76c9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -45,6 +45,18 @@ vkvg is in early development stage, and no guarantee is given on the possible ro
 
 if glslc or xxd are not present, a precompiled version of the shaders is stored in the git tree.
 
+### Building
+
+```bash
+git clone https://github.com/jpbruyere/vkvg.git     # Download source code from github
+cd vkvg                                             # Enter the source directory
+git submodule update --init --recursive             # Dowload vkhelpers sources
+mkdir build                                        # Create build directory
+cd build
+cmake ..                                           # Run CMake, optionaly setup glslc path
+make                                               # Run Make
+```
+
 ### Roadmap
 
 - Improve triangulation algorithm.