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