README.md (2683B)
1 live-sdk 2 ======== 3 4 live-sdk is simple distro build system aimed at creating liveCDs 5 6 ## Requirements 7 8 live-sdk is designed to be used interactively from a terminal. 9 It requires the following packages to be installed in addition to the 10 [dependencies required for libdevuansdk](https://github.com/dyne/libdevuansdk/blob/master/README.md#requirements). 11 12 `sudo` permissions are required for the user that is running the build. 13 14 ### Devuan 15 16 ``` 17 xorriso squashfs-tools live-boot syslinux-common 18 ``` 19 20 ### Gentoo 21 22 ``` 23 dev-libs/libisoburn sys-fs/squashfs-tools sys-boot/syslinux 24 ``` 25 26 ## Initial setup 27 28 After cloning the live-sdk git repository, enter it and issue: 29 30 ``` 31 git submodule update --init --recursive --checkout 32 ``` 33 34 ### Updating 35 36 To update live-sdk, go to the root dir of the git repo and issue: 37 38 ``` 39 git pull && git submodule update --init --recursive --checkout 40 ``` 41 42 ## Quick start 43 44 Edit the `config` file to match your needs. Sensible defaults are 45 already there. Then run zsh. To avoid issues, it's best to start a 46 vanilla version, without preloaded config files so it doesn't cause 47 issues with libdevuansdk/live-sdk functions. 48 49 ``` 50 ; zsh -f -c 'source sdk' 51 ``` 52 53 Now is the time you choose the OS, architecture, and (optionally) a 54 blend you want to build the image for. 55 56 ### Currently supported distros 57 58 * `devuan` 59 60 ``` 61 ; load devuan amd64 62 ``` 63 64 Once initialized, you can run the helper command: 65 66 ``` 67 ; build_iso_dist 68 ``` 69 70 The image will automatically be build for you. Once finished, you will be 71 able to find it in the `dist/` directory in live-sdk's root. 72 73 For more info, see the `doc/` directory. 74 75 ## Acknowledgments 76 77 Devuan's SDK was originally conceived during a period of residency at the 78 Schumacher college in Dartington, UK. Greatly inspired by the laborious and 79 mindful atmosphere of its wonderful premises. 80 81 The Devuan SDK is Copyright (c) 2015-2017 by the Dyne.org Foundation 82 83 Devuan SDK components were designed, and are written and maintained by: 84 85 - Ivan J. <parazyd@dyne.org> 86 - Denis Roio <jaromil@dyne.org> 87 - Enzo Nicosia <katolaz@freaknet.org> 88 89 This source code is free software: you can redistribute it and/or modify it 90 under the terms of the GNU General Public License as published by the Free 91 Software Foundation, either version 3 of the License, or (at your option) 92 any later version. 93 94 This software is distributed in the hope that it will be useful, but 95 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 96 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 97 more details. 98 99 You should have received a copy of the GNU General Public License along 100 with this source code. If not, see <http://www.gnu.org/licenses/>.