Skip to content

Commit

Permalink
CMAKE: Add documentation for speicfying custom version suffix.
Browse files Browse the repository at this point in the history
  • Loading branch information
jamievlin committed Feb 29, 2024
1 parent d05ccd2 commit 1bf3e0e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,17 @@ for my (Jamie's) setup:
}
```

### Additional build information

One can specify additional package string (this is useful for CI for denoting build revision).
To do this, add a file called `asy-pkg-version-suffix.cmake` with a cmake command
```cmake
set(ASY_VERSION_SUFFIX "<custom version suffix>")
```

This suffix will get embedded into the final asymptote version. If this file is not specified, the default
suffix is "+debug" for debug builds, or an empty string for all other builds, including release builds

## Testing

Asymptote unit testing is integerated into CMake's `CTest` framework.
Expand All @@ -104,4 +115,4 @@ ctest --test-dir cmake-build-linux/release/ -R "asy.types.*"
```

# On Windows
See INSTALL-WIN.md for windows-specific instructions.
See INSTALL-WIN.md for windows-specific instructions.

0 comments on commit 1bf3e0e

Please sign in to comment.