From 80697d25658e87bf417b37fbf7e2d31b0ee70f10 Mon Sep 17 00:00:00 2001 From: Jeremy Edwards Date: Wed, 7 Aug 2013 07:22:42 -0700 Subject: Readme has been updated to provide better usage instructions. --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 11a70a2..e937bdc 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ ## Image Packages for Google Compute Engine +This repository is the collection of packages that are installed on the standard Google Compute Engine images. -Scripts and tools for Google Compute Engine images. +1. Image Bundle - Tool that creates an image file out of a disk attached to a GCE VM. +1. Google Startup Scripts - Scripts and configuration files that setup a Linux-based image to work smoothly with GCE. +1. Google Daemon - A service that manages user accounts, maintains ssh login keys, and syncs public endpoint IP addresses. -## Building an Image for Compute Engine +## Installation +The easiest way to install these packages into a Linux-based image is to extract each tarball to `/` (root). Image Bundle does not have a directory structure, it is recommended to it extract to `/usr/share/imagebundle`. The tarballs are available in [releases](https://github.com/GoogleCloudPlatform/compute-image-packages/releases). -If you're building an image from scratch see https://developers.google.com/compute/docs/building_image for details. +Refer to [Building a Google Compute Engine Image](https://developers.google.com/compute/docs/building_image) for the complete guide. -## Licensing +## Source Code +This repository is structured so that each package is located in its own top-level directory. [`google-startup-scripts`](google-startup-scripts/) and [`google-daemon`](google-daemon/) are stored as the directory structure of where the files would be from root. [`image-bundle`](image-bundle/) has no directory structure. -* See [LICENSE](LICENSE) +## License +All files in this repository are under the [Apache License, Version 2.0](LICENSE) unless noted otherwise. -- cgit v1.2.1