Skip to content

Commit 30769fc

Browse files
committed
Explain <version> placeholder
1 parent 3efd288 commit 30769fc

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

doc/installation.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Binary distributions
2525
Each release on the `releases page <https://github.com/dfetch-org/dfetch/releases>`_
2626
provides pre-built installers for all major platforms, so no compilation is required.
2727

28+
Each installer package has a name in the format ``<version>-<platform>``.
29+
30+
- ``<version>`` shows the software version:
31+
32+
- If it includes ``dev``, it is a development release (for testing).
33+
- If it is only numbers (e.g. ``0.11.0``), it is an official release.
34+
35+
- ``<platform>`` indicates the system the installer is for: ``nix`` (Linux), ``osx`` (Mac), or ``win`` (Windows).
36+
37+
The version is automatically determined from the project and used to name the installer files.
38+
2839
.. tabs::
2940

3041
.. tab:: Linux

0 commit comments

Comments
 (0)