Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 44f9fbb

Browse files
Update README.md
Added more details to README.md
1 parent cb98dc9 commit 44f9fbb

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,39 @@
1-
# Instructions
1+
# Stembuild
22

3-
If you have a `.vhd` file and a `.patch` file for that VHD, then:
3+
The stembuild binary is used to build BOSH stemcells for Windows 2012R2 and 2016 v1709 on vSphere. See [here](https://github.com/cloudfoundry-incubator/bosh-windows-stemcell-builder/wiki/Creating-a-vSphere-Stemcell-by-Hand) for instructions to build Windows stemcells for vSphere.
44

5-
```
6-
stembuild -vhd my-vhd.vhd -delta patchfile.patch -version 1000.0
7-
```
5+
It can convert a prepared .vmdk into a stemcell with the appropriate metadata.
86

9-
will create a stemcell with version `1000.0` in your current working directory.
7+
Download the latest stembuild from the [Releases page](https://github.com/pivotal-cf-experimental/stembuild/releases).
8+
9+
## Dependencies
10+
The VMware 'ovftool' binary must be on your path or Fusion/Workstation must be installed (both include the 'ovftool').
11+
12+
## Create a stemcell from a vmdk
13+
14+
Usage `stembuild-linux [OPTIONS...] [-vmdk FILENAME]
15+
[-output DIRNAME] [-version STEMCELL_VERSION]
16+
[-os OS_VERSION]`
1017

1118
Process takes between 10 and 20 minutes. See Progress with `-debug` flag.
1219

20+
## Create a stemcell from a vhd
21+
22+
Usage `stembuild-linux [-output DIRNAME] apply-patch <patch manifest yml>`
23+
24+
will generate a stemcell in the current working directory
25+
1326
Other options available with `stembuild -h`.
1427

15-
# Compilation
28+
## Compilation
1629

1730
See the [wiki](https://github.com/pivotal-cf-experimental/stembuild/wiki/build-stembuild)
1831

19-
# Testing
32+
## Testing
2033

2134
Older tests were written using the default testing framework. However, more recent code
2235
has been test-driven with Ginkgo. We recommend that any new code be test-driven using Ginkgo.
2336

24-
# Vendoring
37+
## Vendoring
2538

2639
Vendoring for this project is done using `dep`.

0 commit comments

Comments
 (0)