# Pismere Build Version Documentation

## Intro

To easily get version information into a particular module using the Pismere build system, you will need a resource script that does the following:

1. Define some stuff
2. include ver.inc

## The Definitions Needed by ver.inc

### Required

`VER_PRODUCTNAME_STR`
  Short description for the product that the file belongs to.
`VER_FILEDESCRIPTION_STR`
  Short description for the file being built.

### Recommended

`VER_PROD_MAJOR`
  Product's major version number. Default is: `1`.
`VER_PROD_MINOR`
  Product's major version number. Default is: `0`.
`VER_PROD_REV`
  Product version's revision number. Default is: `0`.
`VER_PROD_MAJOR_STR`
  String version of product's major version number. Default is: `"1"`.
`VER_PROD_MINOR_STR`
  String version of product's major version number. Default is: `"0"`.
`VER_PROD_REV_STR`
  String version of product version's revision number. Default is: `"0"`.

### Options

`EXPORT_CONTROLLED`
  Define this to indicate the file is export controlled.
`BETA`
  Define this to a non-zero value to indicate that the file is beta (pre-release). A negative value means just some beta. A positive value indicates a particular beta number.
`BETA_STR`
  The string version of `BETA` if `BETA > 0`.

### Overridable

`VER_FILE_MAJOR`
  File's major version number. Default is: `VER_PROD_MAJOR`.
`VER_FILE_MINOR`
  File's major version number. Default is: `VER_PROD_MINOR`.
`VER_FILE_REV`
  File version's revision number. Default is: `VER_PROD_REV`.
`VER_FILE_MAJOR_STR`
  String version of file's major version number. Default is `VER_PROD_MAJOR_STR`.
`VER_FILE_MINOR_STR`
  String version of file's minor version number. Default is `VER_PROD_MINOR_STR`.
`VER_FILE_REV_STR`
  String version of file version's revision number. Default is: `VER_PROD_REV_STR`.

### Other

`VER_LEGALCOPYRIGHT_YEARS`
  Copyright years string. Default is: `"1993-2000"`.
`VER_LEGALCOPYRIGHT_STR`
  Copyright string. Default is: `"Copyright (C) " VER_LEGALCOPYRIGHT_YEARS " by the " VER_MIT`.
`VER_COMPANYNAME_STR`
  Company name string. Default is: `VER_MIT`.

### Useful

`VER_MIT`
  `"Massachusetts Institute of Technology"`