From 81d8c516a84a094ca6626839f510d7f1b691fa3a Mon Sep 17 00:00:00 2001 From: Vasily Date: Thu, 3 Jan 2019 20:05:40 +0100 Subject: [PATCH] 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. --- docs/developer_docs.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/developer_docs.md diff --git a/docs/developer_docs.md b/docs/developer_docs.md new file mode 100644 index 0000000..c7e2f02 --- /dev/null +++ b/docs/developer_docs.md @@ -0,0 +1,23 @@ + +# OpenVR Advanced Settings Developer Docs + +For things that don't directly belong a single place in the source code. + + > * [New Patch Release Checklist](#patch_checklist) + > * [Increment Version Numbers](#inc_vers_numbers) + + +## 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](https://semver.org/) (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. \ No newline at end of file