Documentation (#86)

* Updating documentation to use normal visual studio
* Update vcpkg.json to use "version" instead of "version-string".

Author: takev

.github/appveyor.yml

@@ -143,7 +143,7 @@ install:
   # In short: set "build version number" to "version_num-current_commit_short_hash" or when tagged to "tag name" (Travis style).
   - ps: |
       $vcpkg_json = Get-Content "vcpkg.json" -Raw | ConvertFrom-Json
-      $env:PROJECT_VERSION = $vcpkg_json."version-string"
+      $env:PROJECT_VERSION = $vcpkg_json."version"
       write-host "build_version_number -> $env:build_version_number"
       if ($env:APPVEYOR_REPO_TAG -eq "true")
       {

CMakeLists.txt

@@ -32,7 +32,7 @@ endif()
 # vcpkg.json is the primary source for version data
 file(READ ${CMAKE_SOURCE_DIR}/vcpkg.json VCPKG_JSON_STRING)
 string(JSON APP_NAME     GET ${VCPKG_JSON_STRING} "name")
-string(JSON APP_VERSION  GET ${VCPKG_JSON_STRING} "version-string")
+string(JSON APP_VERSION  GET ${VCPKG_JSON_STRING} "version")
 string(JSON APP_LICENSE  GET ${VCPKG_JSON_STRING} "license")
 string(JSON APP_DESC     GET ${VCPKG_JSON_STRING} "description")
 string(JSON APP_HOMEPAGE GET ${VCPKG_JSON_STRING} "homepage")

docs/CONTRIBUTING.md

@@ -43,7 +43,7 @@ Here is a description on how to install for the development of ttauri.
 
 Installation requirements:
 
- - The latest Microsoft Visual Studio Preview from <https://visualstudio.microsoft.com/vs/preview/>
+ - The latest Microsoft Visual Studio from <https://visualstudio.microsoft.com/downloads/>
    - C++ core desktop features
    - C++ CMake tools for Windows
    - Test Adapter for Google Test
@@ -88,15 +88,15 @@ Select the x64-MSVC-Debug and use the following menu items to build the project:
  - Project / Generate Cache for ttauri
  - Build / Build All
 
-After building you can select "ttauri_demo.exe" from "Select Startup Item..." next to the run-button. Then
+After building you can select "ttauri\_demo.exe" from "Select Startup Item..." next to the run-button. Then
 press that button to run the debug build (with the debugger attached).
 
 You may also want to read the following about how to use CMake projects with visual studio:
 <https://docs.microsoft.com/en-us/cpp/build/cmake-projects-in-visual-studio?view=msvc-160>
 
 #### Developer Command Prompt for VS 2019
 
-If you already have vcpkg installed you still will need to set VCPKG_ROOT and 'integrate'
+If you already have vcpkg installed you still will need to set `VCPKG_ROOT` and 'integrate'
 each time you start a new shell.
 
 ```
@@ -172,3 +172,4 @@ Code of Conduct
 
 This project and everyone participating in it is governed by the
 [TTauri Code of Conduct](https://github.com/ttauri-project/ttauri/blob/main/docs/CODE_OF_CONDUCT.md)
+

docs/code_style.md

@@ -1,5 +1,5 @@
-Code Style rules
-================
+Code Style
+==========
 
 Identifiers
 -----------
@@ -26,18 +26,27 @@ The following identifiers are in CamelCase:
 Capital letters within a snake\_case identifier are allowed for proper nouns and
 abbreviations.
 
+### Common names
+
+Common identifiers:
+
+ - `i`, `j`, `k`: Index inside a loop.
+ - `it`, `jt`, `kt`: Iterator inside a loop.
+ - `r`: Return value being prepared.
+ - `first`, `last`: Iterator arguments to a function.
+
 ### Prefixes and Suffixes
 
 Common prefixes and suffixes:
 
  - prefix `num_`: Size of a list of items. The prefixed name should be plural
  - suffix `_nr`: Ordinal of an item.
  - suffix `_i` `_j` `_k`: Index inside a loop associated with an specific list.
- - suffix `_it` `_jt` `_kt1`: Iterator inside a loop associated with an specific list.
+ - suffix `_it` `_jt` `_kt`: Iterator inside a loop associated with an specific list.
  - prefix `_`: Private or protected member variables and functions.
  - suffix `_`: A variable after conversion to a different type.
- - prefix `tt_`: A macro
  - suffix `_type`: A type created inside a class.
+ - prefix `tt_`: A macro
 
 Private or protected member variables are prefixed with "\_", so that
 getter/setter member functions names will not alias with the variables.
@@ -73,7 +82,7 @@ variable would be a mutex named `mutex`.
 Two phase construction
 ----------------------
 
-When a polymorphic class needs to polymorphic initialization and destruction it should
+When a polymorphic class needs polymorphic initialization and destruction it should
 add the following two virtual functions:
 
  - virtual void `init()`
@@ -114,6 +123,6 @@ Subsystems
 ----------
 
 A subsystem will have a name in the `system_status_type` enum, and will have a global function under the same name
-suffixed with \_start. This subsystem_start function is used to initialize and register the deinitialize function
-with the system_status. The subsystem_start function must be low latency so that it can be called very often to make
+suffixed with \_start. This subsystem\_start function is used to initialize and register the deinitialize function
+with the system\_status. The subsystem\_start function must be low latency so that it can be called very often to make
 sure the subsystem is started when functionality of the subsystem is used for the first time.

vcpkg.json

@@ -1,6 +1,6 @@
 {
     "name": "ttauri",
-    "version-string": "0.3.0",
+    "version": "0.3.0",
     "license": "BSL-1.0",
     "homepage": "https://github.com/ttauri-project/ttauri",
     "description": "A portable, low latency, retained-mode GUI library written in C++.",