Files
OpenVR-AdvancedSettings-frame/docs/developer_docs.md
T
Vasily 81d8c516a8 Add developer docs file
This allows devs on the project to write useful information that might
not fit anywhere else, or might be applicable to multiple things.
2019-01-04 17:07:52 +01:00

1.1 KiB

OpenVR Advanced Settings Developer Docs

For things that don't directly belong a single place in the source code.

New Patch Release Checklist

Increment Version Numbers

Currently there are three version strings in the source.

  1. src\overlaycontroller.h - Variable named applicationVersionString.
  2. build_scripts\win\common.py - Variable named VERSION_STRING.
  3. installer\installer.nsi - Variable named VERSION_STRING.

The first string should be three digits separated by dots (periods), as described in semantic versioning (like "2.8.0"). The second and third should be three digits separated by hyphens/dashes (like "2-8-0").

The reason for the difference is that the first string is only used as a string in the source code, while the second and third are used to name files. Some operating system can become confused with more than one dot in the file name (like Windows). It's better to just avoid the situation entirely.