live-sdk/README.md

72 lines
1.5 KiB
Markdown

live-sdk
========
live-sdk is simple distro build system aimed at creating liveCDs
## Requirements
live-sdk is designed to be used interactively from a terminal.
It requires the following packages to be installed in addition to the
[dependencies required for libdevuansdk](https://github.com/parazyd/libdevuansdk/blob/master/README.md#requirements).
`sudo` permissions are required for the user that is running the build.
### Devuan
```
xorriso squashfs-tools live-boot syslinux-common
```
### Gentoo
```
dev-libs/libisoburn sys-fs/squashfs-tools sys-boot/syslinux
```
## Initial setup
After cloning the live-sdk git repository, enter it and issue:
```
git submodule update --init --recursive --checkout
```
### Updating
To update live-sdk, go to the root dir of the git repo and issue:
```
git pull && git submodule update --init --recursive --checkout
```
## Quick start
Edit the `config` file to match your needs. Sensible defaults are
already there. Then run zsh. To avoid issues, it's best to start a
vanilla version, without preloaded config files so it doesn't cause
issues with libdevuansdk/live-sdk functions.
```
; zsh -f -c 'source sdk'
```
Now is the time you choose the OS, architecture, and (optionally) a
blend you want to build the image for.
### Currently supported distros
* `devuan`
```
; load devuan amd64
```
Once initialized, you can run the helper command:
```
; build_iso_dist
```
The image will automatically be build for you. Once finished, you will be
able to find it in the `dist/` directory in live-sdk's root.