mirrors/limine
1
0
Fork 0
mirror of https://github.com/limine-bootloader/limine synced 2025-01-11 23:29:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

misc: Update warning about unstable branch in README

Browse Source
This commit is contained in:
mintsuki 2021-01-15 05:08:21 +01:00
parent 9363b8c4db
commit 3184e0a026
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -32,7 +32,9 @@ you have a *very* good reason to.
The `unstable` branch is unstable, and non-backwards compatible changes are made to it The `unstable` branch is unstable, and non-backwards compatible changes are made to it
routinely. routinely.
Use instead a [release](https://github.com/limine-bootloader/limine/releases). Use instead a [release](https://github.com/limine-bootloader/limine/releases), or a [release branch](https://github.com/limine-bootloader/limine/branches) (like v1.0-branch).
Following a release offers a fixed point, immutable snapshot of Limine, while following a release branch tracks the latest changes made to that major release's branch which do not break compatibility (but could break in other, non-obvious ways).
One can clone a release directly using One can clone a release directly using
```bash ```bash
@ -40,6 +42,12 @@ git clone https://github.com/limine-bootloader/limine.git --branch=v1.0
``` ```
(replace `v1.0` with the chosen release) (replace `v1.0` with the chosen release)
or a release branch with
```bash
git clone https://github.com/limine-bootloader/limine.git --branch=v1.0-branch
```
(replace `v1.0-branch` with the chosen release branch)
Also note that the documentation contained in `unstable` does not reflect the Also note that the documentation contained in `unstable` does not reflect the
documentation for the specific releases, and one should refer to the releases' documentation for the specific releases, and one should refer to the releases'
documentation instead, contained in their files. documentation instead, contained in their files.