butter/churn
6
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

docs: add BSD licence and enhance README

Browse source
This commit is contained in:
Iain Learmonth 2026-04-06 11:09:26 +01:00
parent 2c103e8b00
commit 6a4822fcfb
2 changed files with 82 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,5 +1,28 @@
# Churn
# Butter Churn
This is work in progress.
[![License](https://img.shields.io/badge/License-BSD_3--Clause-orange.svg)](https://opensource.org/licenses/BSD-3-Clause)
To build a butter image, run vmdb2 --rootfs-tarball=my_image.tar.gz --output my_image.img --log my_image.log
Tool for building Butter Box disk images.
## Usage
To build a butter image, run:
```sh
vmdb2 --rootfs-tarball=my_image.tar.gz --output my_image.img --log my_image.log
```
## Copyright and Licence
© 2017, Michael Stapelberg and contributors
© 2021 guardianproject
© SR2 Communications Limited
See [LICENCE](./LICENCE) for details of the BSD-3 clause licence.
This project is a derivative work of:
* [Butter Box for Raspberry Pi](https://gitlab.com/likebutter/butterbox-rpi)
licensed under the MIT licence.
* [Raspberry Pi Image Specs](https://salsa.debian.org/raspi-team/image-specs)
licensed under the 3-clause BSD licence.