Use compile-time constants instead of unnamed enumerations (remove "enum hack")
[bitcoinplatinum.git] / contrib / gitian-descriptors / README.md
blob614970659660f8fee76b8859467e192795829de4
1 ### Gavin's notes on getting gitian builds up and running using KVM
3 These instructions distilled from
4 [https://help.ubuntu.com/community/KVM/Installation](https://help.ubuntu.com/community/KVM/Installation).
6 You need the right hardware: you need a 64-bit-capable CPU with hardware virtualization support (Intel VT-x or AMD-V). Not all modern CPUs support hardware virtualization.
8 You probably need to enable hardware virtualization in your machine's BIOS.
10 You need to be running a recent version of 64-bit-Ubuntu, and you need to install several prerequisites:
12         sudo apt-get install ruby apache2 git apt-cacher-ng python-vm-builder qemu-kvm
14 Sanity checks:
16         sudo service apt-cacher-ng status  # Should return apt-cacher-ng is running
17         ls -l /dev/kvm   # Should show a /dev/kvm device
20 Once you've got the right hardware and software:
22     git clone git://github.com/bitcoin/bitcoin.git
23     git clone git://github.com/devrandom/gitian-builder.git
24     mkdir gitian-builder/inputs
25     cd gitian-builder/inputs
27     # Create base images
28     cd gitian-builder
29     bin/make-base-vm --suite trusty --arch amd64
30     cd ..
32     # Get inputs (see doc/release-process.md for exact inputs needed and where to get them)
33     ...
35     # For further build instructions see doc/release-process.md
36     ...
38 ---------------------
40 `gitian-builder` now also supports building using LXC. See
41 [help.ubuntu.com](https://help.ubuntu.com/14.04/serverguide/lxc.html)
42 for how to get LXC up and running under Ubuntu.
44 If your main machine is a 64-bit Mac or PC with a few gigabytes of memory
45 and at least 10 gigabytes of free disk space, you can `gitian-build` using
46 LXC running inside a virtual machine.
48 Here's a description of Gavin's setup on OSX 10.6:
50 1. Download and install VirtualBox from [https://www.virtualbox.org/](https://www.virtualbox.org/)
52 2. Download the 64-bit Ubuntu Desktop 12.04 LTS .iso CD image from
53    [http://www.ubuntu.com/](http://www.ubuntu.com/)
55 3. Run VirtualBox and create a new virtual machine, using the Ubuntu .iso (see the [VirtualBox documentation](https://www.virtualbox.org/wiki/Documentation) for details). Create it with at least 2 gigabytes of memory and a disk that is at least 20 gigabytes big.
57 4. Inside the running Ubuntu desktop, install:
59         sudo apt-get install debootstrap lxc ruby apache2 git apt-cacher-ng python-vm-builder
61 5. Still inside Ubuntu, tell gitian-builder to use LXC, then follow the "Once you've got the right hardware and software" instructions above:
63         export USE_LXC=1
64         git clone git://github.com/bitcoin/bitcoin.git
65         ... etc