test rtd 2

diff --git a/building/README.md b/building/README.md
new file mode 100644 (file)
index 0000000..eb49247
--- /dev/null
+++ b/building/README.md
@@ -0,0 +1,5 @@
+---
+sort: 1
+---
+
+{% include list.liquid %}

diff --git a/building/building.md b/building/building.md
new file mode 100644 (file)
index 0000000..cdada10
--- /dev/null
+++ b/building/building.md
@@ -0,0 +1,20 @@
+---
+layout: default
+title: Building
+nav_order: 2
+has_children: true
+permalink: /docs/building
+---
+
+## Requirements:
+
+- [CMake](https://cmake.org/): version > 12.
+- [Vulkan](https://www.khronos.org/vulkan/)
+- [FontConfig](https://www.freedesktop.org/wiki/Software/fontconfig/)
+- [Freetype](https://www.freetype.org/)
+- [Harfbuzz](https://www.freedesktop.org/wiki/Software/HarfBuzz/)
+- GLSLC: spirv compiler, included in [LunarG SDK](https://www.lunarg.com/vulkan-sdk/) (building only)
+- [xxd](https://linux.die.net/man/1/xxd): generate headers with precompiled shaders (building only)
+- [GLFW](http://www.glfw.org/): optional, if present tests are built.
+
+if `glslc` or `xxd` are not present, a precompiled version of the shaders is stored in the git tree.

diff --git a/building/debian.md b/building/debian.md
new file mode 100644 (file)
index 0000000..fd31268
--- /dev/null
+++ b/building/debian.md
@@ -0,0 +1,46 @@
+---
+layout: default
+title: Debian instructions
+parent: Building
+nav_order: 1
+---
+
+# Install Dependencies
+
+`glslc` and `xxd` are required to compile the shaders. If one of them is not installed, a precompiled version of the shaders is stored in the git tree.
+
+### build tools
+```bash
+sudo apt install git cmake gcc g++ xxd
+```
+
+### vulkan lib and tools
+
+###### from debian packages
+```bash
+sudo apt install libvulkan-dev mesa-vulkan-drivers
+```
+###### from lunarg sdk
+```bash
+
+```
+ 
+##### build dependencies
+```bash
+sudo apt-get install libfontconfig-dev libfreetype-dev libharfbuzz-dev  
+```
+
+
+## Getting the sources from GitHub
+
+```bash
+#fetch sources from github
+git clone --recursive https://github.com/jpbruyere/vkvg.git    
+cd vkvg
+# Create build directory
+mkdir build
+cd build
+# Run CMake, optionaly setup glslc path
+cmake ..
+make
+```

diff --git a/building/windows.md b/building/windows.md
new file mode 100644 (file)
index 0000000..e6fb3af
--- /dev/null
+++ b/building/windows.md
@@ -0,0 +1,62 @@
+---
+layout: default
+title: Windows instructions
+parent: Building
+nav_order: 2
+---
+
+#  Build on Windows with Visual Studio IDE:
+
+(*Tested with VS 2017*)
+Ensure [CMake and c/c++ support options](https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2019) are installed along with Visual studio.
+
+The easyest way to proceed is to open a visual studio command prompt, and issue commands manually. Once dependencies are build and vkvg project files have been created, you may use the ide.
+
+#### Build dependencies
+Install the latest [vulkan sdk](https://vulkan.lunarg.com/) from lunarg.
+
+Make sure that [Git](https://git-scm.com/download/win) is installed on your machine by typing on the command line (cmd):
+```bash
+> git --version
+git version 2.19.1.windows.1
+```
+Install [vcpkg package manager](https://docs.microsoft.com/en-us/cpp/build/vcpkg?view=vs-2019) to build required libraries:
+```bash 
+git clone https://github.com/Microsoft/vcpkg.git
+cd vcpkg
+.\bootstrap-vcpkg.bat
+```
+Then install the libraries required by vkvg, use the triplet corresponding with your architecture:
+```bash 
+vcpkg install fontconfig:x64-window freetype:x64-window harfbuzz:x64-window
+```
+Optionaly, install [GLFW] to build the samples:
+```bash 
+vcpkg install glfw:x64-window
+```
+Add the path to the shared libraries binaries to your **PATH** environment variable, they are in %vcpkg-root%/installed/x64-windows/bin/.
+
+To make those libraries available for vsstudio use the [system wide integration](https://vcpkg.readthedocs.io/en/latest/examples/installing-and-using-packages/#vsmsbuild-project-user-wide-integration) from vcpkg.
+```bash 
+vcpkg integrate install
+```
+#### CMake configuration
+Exit vcpkg directory and clone the vkvg repository and its submodule vkh:
+```bash
+git clone --recursive https://github.com/jpbruyere/vkvg.git
+cd vkvg
+#create a build directory
+mkdir build
+```
+To generate the solution file (.sln) from the build directory we use cmake with the toolchain file provided by vcpkg and we also disable the lcd font filtering (FreeType is built without [lcd fonts](https://en.wikipedia.org/wiki/Subpixel_rendering) by default).
+```
+cmake .. -DCMAKE_TOOLCHAIN_FILE=..\..\vcpkg\scripts\buildsystems\vcpkg.cmake -DVKVG_LCD_FONT_FILTER=off
+```
+To adjust later compilation options, you may recall cmake command, or use the cmake-gui command.
+```bash
+cmake-gui ..
+```
+Now you should have the vkvg.sln and all the projects file into your build directory. You may build the complete solution on the command line with:
+```bash
+msbuild vkvg.sln
+```

diff --git a/docs/building/building.md b/docs/building/building.md
deleted file mode 100644 (file)
index cdada10..0000000
--- a/docs/building/building.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-layout: default
-title: Building
-nav_order: 2
-has_children: true
-permalink: /docs/building
----
-
-## Requirements:
-
-- [CMake](https://cmake.org/): version > 12.
-- [Vulkan](https://www.khronos.org/vulkan/)
-- [FontConfig](https://www.freedesktop.org/wiki/Software/fontconfig/)
-- [Freetype](https://www.freetype.org/)
-- [Harfbuzz](https://www.freedesktop.org/wiki/Software/HarfBuzz/)
-- GLSLC: spirv compiler, included in [LunarG SDK](https://www.lunarg.com/vulkan-sdk/) (building only)
-- [xxd](https://linux.die.net/man/1/xxd): generate headers with precompiled shaders (building only)
-- [GLFW](http://www.glfw.org/): optional, if present tests are built.
-
-if `glslc` or `xxd` are not present, a precompiled version of the shaders is stored in the git tree.

diff --git a/docs/building/debian.md b/docs/building/debian.md
deleted file mode 100644 (file)
index fd31268..0000000
--- a/docs/building/debian.md
+++ /dev/null
@@ -1,46 +0,0 @@
----
-layout: default
-title: Debian instructions
-parent: Building
-nav_order: 1
----
-
-# Install Dependencies
-
-`glslc` and `xxd` are required to compile the shaders. If one of them is not installed, a precompiled version of the shaders is stored in the git tree.
-
-### build tools
-```bash
-sudo apt install git cmake gcc g++ xxd
-```
-
-### vulkan lib and tools
-
-###### from debian packages
-```bash
-sudo apt install libvulkan-dev mesa-vulkan-drivers
-```
-###### from lunarg sdk
-```bash
-
-```
- 
-##### build dependencies
-```bash
-sudo apt-get install libfontconfig-dev libfreetype-dev libharfbuzz-dev  
-```
-
-
-## Getting the sources from GitHub
-
-```bash
-#fetch sources from github
-git clone --recursive https://github.com/jpbruyere/vkvg.git    
-cd vkvg
-# Create build directory
-mkdir build
-cd build
-# Run CMake, optionaly setup glslc path
-cmake ..
-make
-```

diff --git a/docs/building/windows.md b/docs/building/windows.md
deleted file mode 100644 (file)
index e6fb3af..0000000
--- a/docs/building/windows.md
+++ /dev/null
@@ -1,62 +0,0 @@
----
-layout: default
-title: Windows instructions
-parent: Building
-nav_order: 2
----
-
-#  Build on Windows with Visual Studio IDE:
-
-(*Tested with VS 2017*)
-Ensure [CMake and c/c++ support options](https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2019) are installed along with Visual studio.
-
-The easyest way to proceed is to open a visual studio command prompt, and issue commands manually. Once dependencies are build and vkvg project files have been created, you may use the ide.
-
-#### Build dependencies
-Install the latest [vulkan sdk](https://vulkan.lunarg.com/) from lunarg.
-
-Make sure that [Git](https://git-scm.com/download/win) is installed on your machine by typing on the command line (cmd):
-```bash
-> git --version
-git version 2.19.1.windows.1
-```
-Install [vcpkg package manager](https://docs.microsoft.com/en-us/cpp/build/vcpkg?view=vs-2019) to build required libraries:
-```bash 
-git clone https://github.com/Microsoft/vcpkg.git
-cd vcpkg
-.\bootstrap-vcpkg.bat
-```
-Then install the libraries required by vkvg, use the triplet corresponding with your architecture:
-```bash 
-vcpkg install fontconfig:x64-window freetype:x64-window harfbuzz:x64-window
-```
-Optionaly, install [GLFW] to build the samples:
-```bash 
-vcpkg install glfw:x64-window
-```
-Add the path to the shared libraries binaries to your **PATH** environment variable, they are in %vcpkg-root%/installed/x64-windows/bin/.
-
-To make those libraries available for vsstudio use the [system wide integration](https://vcpkg.readthedocs.io/en/latest/examples/installing-and-using-packages/#vsmsbuild-project-user-wide-integration) from vcpkg.
-```bash 
-vcpkg integrate install
-```
-#### CMake configuration
-Exit vcpkg directory and clone the vkvg repository and its submodule vkh:
-```bash
-git clone --recursive https://github.com/jpbruyere/vkvg.git
-cd vkvg
-#create a build directory
-mkdir build
-```
-To generate the solution file (.sln) from the build directory we use cmake with the toolchain file provided by vcpkg and we also disable the lcd font filtering (FreeType is built without [lcd fonts](https://en.wikipedia.org/wiki/Subpixel_rendering) by default).
-```
-cmake .. -DCMAKE_TOOLCHAIN_FILE=..\..\vcpkg\scripts\buildsystems\vcpkg.cmake -DVKVG_LCD_FONT_FILTER=off
-```
-To adjust later compilation options, you may recall cmake command, or use the cmake-gui command.
-```bash
-cmake-gui ..
-```
-Now you should have the vkvg.sln and all the projects file into your build directory. You may build the complete solution on the command line with:
-```bash
-msbuild vkvg.sln
-```