diff --git a/README.md b/README.md index aa8d0c6b2..2b8e93951 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,28 @@ [![Build Status](https://travis-ci.com/cloud-hypervisor/cloud-hypervisor.svg?branch=master)](https://travis-ci.com/cloud-hypervisor/cloud-hypervisor) -1. [What is Cloud Hypervisor?](#1-what-is-cloud-hypervisor) - * [Requirements](#requirements) - + [High Level](#high-level) - + [Architectures](#architectures) - + [Guest OS](#guest-os) -2. [Getting Started](#2-getting-started) - * [Clone and build](#clone-and-build) - * [Run](#run) - + [Cloud image](#cloud-image) - + [Custom kernel and disk image](#custom-kernel-and-disk-image) - - [Building your kernel](#building-your-kernel) - - [Disk image](#disk-image) - - [Booting the guest VM](#booting-the-guest-vm) -3. [Status](#2-status) - * [Device Model](#device-model) - * [TODO](#todo) -4. [rust-vmm dependency](#4-rust-vmm-dependency) - * [Firecracker and crosvm](#firecracker-and-crosvm) -5. [Community](#5-community) - * [Contribute](#contribute) - * [Join us](#join-us) -6. [Security](#6-security) +- [1. What is Cloud Hypervisor?](#1-what-is-cloud-hypervisor) + - [Objectives](#objectives) + - [High Level](#high-level) + - [Architectures](#architectures) + - [Guest OS](#guest-os) +- [2. Getting Started](#2-getting-started) + - [Clone and build](#clone-and-build) + - [Containerized builds and tests](#containerized-builds-and-tests) + - [Run](#run) + - [Cloud image](#cloud-image) + - [Custom kernel and disk image](#custom-kernel-and-disk-image) + - [Building your kernel](#building-your-kernel) + - [Disk image](#disk-image) + - [Booting the guest VM](#booting-the-guest-vm) +- [3. Status](#3-status) + - [Hot Plug](#hot-plug) + - [Device Model](#device-model) + - [TODO](#todo) +- [4. `rust-vmm` project dependency](#4-rust-vmm-project-dependency) + - [Firecracker and crosvm](#firecracker-and-crosvm) +- [5. Community](#5-community) + - [Contribute](#contribute) + - [Join us](#join-us) # 1. What is Cloud Hypervisor?