Update README.md
This commit is contained in:
parent
97ec3db65d
commit
f32bea5147
40
README.md
40
README.md
@ -1,19 +1,41 @@
|
|||||||
# qloader2
|
# qloader2
|
||||||
x86/x86_64 BIOS Bootloader
|
x86/x86_64 BIOS Bootloader
|
||||||
|
|
||||||
|
### Supported boot protocols
|
||||||
|
* Linux
|
||||||
|
* stivale (qloader2's native boot protocol, TODO: write specification)
|
||||||
|
|
||||||
|
### Supported filesystems
|
||||||
|
* ext2 (root directory only)
|
||||||
|
* echfs (root directory only)
|
||||||
|
|
||||||
|
### Supported partitioning schemes
|
||||||
|
* MBR
|
||||||
|
* GPT
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
This repository contains a prebuilt version of qloader2 so building it won't
|
This repository contains a prebuilt version of qloader2 so building it won't
|
||||||
be necessary.
|
be necessary.
|
||||||
|
|
||||||
In order to install qloader2 on a device (which can just be a raw image file),
|
In order to install qloader2 on a MBR device (which can just be a raw image file),
|
||||||
run the provided `qloader2-install` script as such:
|
run the provided `qloader2-install` script as such:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./qloader2-install ./qloader2.bin <path to device/image>
|
./qloader2-install ./qloader2.bin <path to device/image>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If using a GPT formatted device, it will be necessary to create an extra partition
|
||||||
|
(of at least 32K in size) to store stage 2 code. Then it will be necessary to tell
|
||||||
|
the install script where this partition is located by specifying the start sector.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
fdisk <device> # Create bootloader partition using your favourite method
|
||||||
|
./qloader2-install ./qloader2.bin <path to device/image> <start sector of boot partition>
|
||||||
|
```
|
||||||
|
|
||||||
Then make sure the device/image contains at least 1 partition formatted in
|
Then make sure the device/image contains at least 1 partition formatted in
|
||||||
echfs containing a `qloader2.cfg` file and the kernel/modules one wants to load.
|
a supported filesystem containing a `qloader2.cfg` file and the kernel/modules one
|
||||||
|
wants to load.
|
||||||
|
|
||||||
An example `qloader2.cfg` file can be found in `test/qloader2.cfg`.
|
An example `qloader2.cfg` file can be found in `test/qloader2.cfg`.
|
||||||
|
|
||||||
@ -35,3 +57,17 @@ echfs-utils -m -p0 test.img import <path to file> <path in image>
|
|||||||
```
|
```
|
||||||
|
|
||||||
One can get `echfs-utils` by installing https://github.com/qword-os/echfs.
|
One can get `echfs-utils` by installing https://github.com/qword-os/echfs.
|
||||||
|
|
||||||
|
## Building from source
|
||||||
|
In order to hack qloader2, one must build the GCC toolchain from source first.
|
||||||
|
|
||||||
|
To do so, run the `make_toolchain.sh` script from within the `toolchain` directory;
|
||||||
|
keep in mind that the script takes `MAKEFLAGS` as an argument.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd toolchain
|
||||||
|
./make_toolchain.sh -j4
|
||||||
|
```
|
||||||
|
|
||||||
|
After that is done, simply run `make` in the root of the repo to generate
|
||||||
|
`src/qloader2.bin`.
|
||||||
|
Loading…
Reference in New Issue
Block a user