Skip to content

Commit

Permalink
Update README and help of coinbootmaker
Browse files Browse the repository at this point in the history
  • Loading branch information
frzb committed Jan 19, 2019
1 parent b8806e8 commit 6b23f72
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ It also contains `coinbootmaker` - a little helper to build your own Coinboot pl

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

## Requirements
## Requirements

* A running Coinboot setup
### If you want to build plugins on your own:

* Docker if you want to build plugins on your own
* Docker

* a Debian or Ubuntu build host

Expand All @@ -31,19 +31,23 @@ into the `plugins` directory of your Coinboot setup.
To build Coinboot plugins on your own use `coinbootmaker`.

```
$ ./coinbootmaker <path to Coinboot Initramfs>
Usage: coinbootmaker [-i] -p <file name> <path to initramfs>
-i Interactive mode - opens a shell in the build environment
-p <file name> Plugin to build
-h Display this help
```

For example:

```
$ ./coinbootmaker /tmp/coinboot-initramfs-4.15.0-43-generic
$ ./coinbootmaker /tmp/coinboot-initramfs-4.15.0-43-generic -p ethminer
```

`coinbootmaker` takes a path to a Coinboot-Initramfs to create an environment for building the plugins
by converting the given Initramfs into a Container image and run it.
All plugin scripts located at `src` are than executed in that `coinbootmaker` container and the resulting
plugin archives are written to the `build` directory.
The plugin creation script located at `src` is executed in that `coinbootmaker` container and the resulting
plugin archive is written to the `build` directory.

## License

Expand Down
4 changes: 1 addition & 3 deletions coinbootmaker
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,9 @@ display_help() {
echo 'Coinbootmaker creates an environment for building Coinboot plugins from a'
echo 'given Coinboot Initramfs.'
echo
echo 'When no arguments beside the path to a Coinboot Initramfs is supplied'
echo 'Coinbootmaker automatically builds all plugins from the ./src directory.'
echo 'Packaged Coinboot pluings are written to the ./builds directory'
echo
echo 'Usage: coinbootmaker [-i] <path to initramfs>'
echo 'Usage: coinbootmaker [-i] [-h] -p <file name> <path to initramfs> '
echo
echo '-i Interactive mode - opens a shell in the build environment'
echo '-p <file name> Plugin to build'
Expand Down

0 comments on commit 6b23f72

Please sign in to comment.