Skip to content

Commit

Permalink
Add 'How to build' section
Browse files Browse the repository at this point in the history
  • Loading branch information
thomaslevesque committed Oct 9, 2021
1 parent 67355e9 commit 3a0b6e2
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,10 @@ Features
* Notification when the animation completes, in case you need to do something after the animation
* Animation preview in design mode (must be enabled explicitly)
* Support for controlling the animation manually (pause/resume/seek)

How to build
------------

Run `build.cmd`.

Note: the library's version number is determined by [MinVer](https://github.com/adamralph/minver) based on Git history and tags. A consequence of this is that if you build the project outside a Git repository (e.g. if you just download sources), you'll get a version number of 0.0.0.0. So, in order to build with the correct version number, make sure you're in a Git clone of the project, and that your clone has the tags from the upstream project (`git fetch upstream --tags`, assuming your remote for the upstream project is named `upstream`).

0 comments on commit 3a0b6e2

Please sign in to comment.