diff --git a/docs/Installing.rst b/docs/Installing.rst index 8a04b7cb9..14b5a0f93 100644 --- a/docs/Installing.rst +++ b/docs/Installing.rst @@ -48,10 +48,6 @@ DF version - see `above ` for details. For example: * ``dfhack-50.07-r1-Windows-64bit.zip`` supports 64-bit DF on Windows -In between stable releases, we may create beta releases to test new features. -These are available via the beta release channel on Steam or from our regular -Github page as a pre-release tagged with a "beta" suffix. - .. warning:: Do *not* download the source code from GitHub, either from the releases page @@ -60,6 +56,31 @@ Github page as a pre-release tagged with a "beta" suffix. you want to compile DFHack instead of using a pre-built release, see `building-dfhack-index` for instructions.) +Beta releases +------------- + +In between stable releases, we may create beta releases to test new features. +These are available via the ``beta`` release channel on Steam or from our +regular Github page as a pre-release tagged with a "beta" or "rc" suffix. + +Development builds +------------------ + +If you are actively working with the DFHack team on testing a feature, you may +want to download and install a development build. They are available via the +``testing`` release channel on Steam or can be downloaded from the build +artifact list on GitHub for specific repository commits. + +To download a development build from GitHub: + +- Ensure you are logged into your GitHub account +- Go to https://github.com/DFHack/dfhack/actions/workflows/build.yml?query=branch%3Adevelop+event%3Apush +- Click on the first entry that has a green checkmark +- Click the number under "Artifacts" (or scroll down) +- Click on the "dfhack-*-build-*" artifact for your platform to download + +You can extract this package the same as if you are doing a manual install (see the next section). + Installing DFHack ================= diff --git a/docs/changelog.txt b/docs/changelog.txt index 3ae9fd2a6..36636d001 100644 --- a/docs/changelog.txt +++ b/docs/changelog.txt @@ -67,6 +67,7 @@ Template for new versions: - `sort`: display a rating relative to the current sort order next to the visible units on the squad assignment screen ## Documentation +- add instructions for downloading development builds to the ``Installing`` page ## API - `overlay`: overlay widgets can now declare a ``version`` attribute. changing the version of a widget will reset its settings to defaults. this is useful when changing the overlay layout and old saved positions will no longer be valid.