Skip to content

Commit 1bd714d

Browse files
committed
Update README
1 parent b8a1bf5 commit 1bd714d

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,45 @@
1+
12
![Logo of Coinboot](https://raw.githubusercontent.com/frzb/coinboot/master/coinboot.png)
23

34
## Plugins for Coinboot
45

5-
This repository contains plugins for Coinboot which expand Coinboot
6-
with further software.
7-
Coinboot is a framework for diskless computing.
6+
Coinboot is a framework for diskless computing.
7+
This repository contains plugins for Coinboot which expand Coinboot with further software and functionalities.
8+
It also contains `coinbootmaker` - a little helper to build your own Coinboot plugins.
89

910
For more information how to boot your machines with Coinboot visit: https://coinboot.io
1011

1112
## Requirements
1213

1314
* A running Coinboot setup
1415

16+
* Docker if you want to build plugins on your own
17+
1518
## Usage
1619

17-
Put the plugins your want to use into the `plugins` directory of your Coinboot setup.
20+
### Pre-built Plugins
21+
22+
Put the pre-built plugins of your choice that your can download under [releases](https://github.com/frzb/coinboot-plugins/releases)
23+
into the `plugins` directory of your Coinboot setup.
24+
25+
### Build the Plugins
26+
27+
To build Coinboot plugins on your own use `coinbootmaker`.
28+
29+
```
30+
$ ./coinbootmaker <path to Coinboot Initramfs>
31+
```
32+
33+
For example:
34+
35+
```
36+
$ ./coinbootmaker /tmp/coinboot-initramfs-4.4.0-133-generic
37+
```
38+
39+
`coinbootmaker` takes a path to a Coinboot-Initramfs to create an environment for building the plugins
40+
by converting the given Initramfs into a Docker container image.
41+
All plugin scripts located at `src` are than executed in that `coinbootmaker` container and the resulting
42+
plugin archives are written to the `build` directory.
1843

1944
## License
2045

0 commit comments

Comments
 (0)