misc: Update documentation
This commit is contained in:
mintsuki
parent
af53421cd0
commit
eaeab80c4a
9
.github/ISSUE_TEMPLATE/bug_report.md
vendored
9
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -8,10 +8,7 @@ assignees: ''
|
||||
---
|
||||
|
||||
**Limine version used**
|
||||
Put the version of Limine where the bug was encountered here. If using `unstable`, the commit hash.
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
Put the version of Limine where the bug was encountered here. If using `trunk`, the commit hash.
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
@ -23,9 +20,7 @@ A clear and concise description of what happens instead.
|
||||
Steps to reproduce the behavior, if possible.
|
||||
|
||||
**Stacktrace**
|
||||
If the bug results in a panic, please add a `STAGE2_MAP=<uri>` key to your config file where `<uri>` is a URI that points to the `stage2.map` file. This file is shipped in the root of the repository, or alternatively generated when compiling Limine.
|
||||
|
||||
Show the resulting the stacktrace here.
|
||||
If the bug results in a panic, show the resulting the stacktrace here.
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
|
||||
@ -60,8 +60,6 @@ Some keys take *URIs* as values; these are described in the next section.
|
||||
* `THEME_MARGIN` - Set the amount of margin around the terminal. Ignored if `GRAPHICS` is not `yes`.
|
||||
* `THEME_MARGIN_GRADIENT` - Set the thickness in pixel for the gradient around the terminal. Ignored if `GRAPHICS` is not `yes`.
|
||||
* `BACKGROUND_PATH` - URI where to find the background .BMP file. Ignored if `GRAPHICS` is not `yes`.
|
||||
* `E9_OUTPUT` - If set to `yes`, output to port 0xe9 for debugging purposes.
|
||||
* `COM1_OUTPUT` - If set to `yes`, output to COM1 for debugging purposes.
|
||||
|
||||
*Locally assignable (non protocol specific)* keys are:
|
||||
* `PROTOCOL` - The boot protocol that will be used to boot the kernel. Valid protocols are: `linux`, `stivale`, `stivale2`, `chainload`.
|
||||
|
||||
46
README.md
46
README.md
@ -27,6 +27,23 @@ such as Long Mode, 5-level paging, and SMP (multicore), to name a few.
|
||||
* GPT
|
||||
* Unpartitioned media
|
||||
|
||||
## Binary releases
|
||||
|
||||
For convenience, for point releases, binaries are distributed. These binaries are
|
||||
shipped in the `-binary` branches and tags of this repository (see [branches](https://github.com/limine-bootloader/limine/branches/all) and [tags](https://github.com/limine-bootloader/limine/tags)).
|
||||
|
||||
For example, to clone the latest binary release of the `v2.0` branch one can do
|
||||
```bash
|
||||
git clone https://github.com/limine-bootloader/limine.git --branch=v2.0-branch-binary --depth=1
|
||||
```
|
||||
or, to clone a specific binary point release (for example v2.0.1)
|
||||
```bash
|
||||
git clone https://github.com/limine-bootloader/limine.git --branch=v2.0.1-binary --depth=1
|
||||
```
|
||||
|
||||
`limine-install` binaries are provided for Linux and Windows. In case one wants to
|
||||
rebuild `limine-install`, simply use `make` in the binary release.
|
||||
|
||||
## Warning about using `trunk`
|
||||
|
||||
Please refrain from using the `trunk` branch of this repository directly, unless
|
||||
@ -34,29 +51,15 @@ you have a *very* good reason to.
|
||||
The `trunk` branch is unstable, and non-backwards compatible changes are made to it
|
||||
routinely.
|
||||
|
||||
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
|
||||
```bash
|
||||
git clone https://github.com/limine-bootloader/limine.git --branch=v1.0
|
||||
```
|
||||
(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 `trunk` does not reflect the
|
||||
documentation for the specific releases, and one should refer to the releases'
|
||||
respective documentation instead, contained in their files.
|
||||
|
||||
## Building
|
||||
## Building the bootloader
|
||||
|
||||
*These steps are not necessary if cloning a binary release. if so, skip to the*
|
||||
*next paragraph.*
|
||||
|
||||
### Building the bootloader
|
||||
It is necessary to first build the set of tools that the bootloader needs
|
||||
in order to be built.
|
||||
|
||||
@ -73,9 +76,10 @@ make
|
||||
|
||||
The generated bootloader files are going to be in `bin`.
|
||||
|
||||
### Installing Limine binaries
|
||||
This step is optional as the bootloader binaries can be used from the `bin`
|
||||
directory just fine. This step will only install them in a `share` and `bin`
|
||||
## Installing Limine binaries
|
||||
|
||||
This step is optional as the bootloader binaries can be used from the `bin` or
|
||||
release directory just fine. This step will only install them in a `share` and `bin`
|
||||
directories in the specified `PREFIX` (default is `/usr/local`).
|
||||
|
||||
Use `make install` to install Limine binaries, optionally specifying a prefix with a
|
||||
|
||||
Loading…
Reference in New Issue
Block a user