Skip to content

Commit a31b878

Browse files
committed
doc: the quickstart is not one - 'Getting to know CuOS'
It builds, boots, then spends six sections updating, patching, rolling back and factory-resetting. That is a guided tour, and its own lead already said so: 'this page is for looking inside afterwards'. The name promised the opposite, and it collided with cuos-release's Quickstart, which really is three commands. Also removed: '(Variant 2 or 3 style)', a leftover of the deleted variants.
1 parent 7171a7c commit a31b878

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ and VMs, one machine or a fleet.
3939
| build a bootable system — disk image, ISO installer or LXC container | [cuos-release](https://github.com/cuos-dev/cuos-release#readme) |
4040
| deploy and manage services on one | [cuos-iac](https://github.com/cuos-dev/cuos-iac#readme) |
4141
| build your own OS or init app on CuOS | [Development Guide](docs/development-guide.md) |
42-
| see the pieces working end to end | [Quickstart](docs/quickstart.md) |
42+
| build one and take it apart, to learn how it works | [Getting to know CuOS](docs/getting-to-know-cuos.md) |
4343

4444
The name is the description: **C**ontainer **U**pdate **OS** — built from a
4545
container, updates itself, and is a whole operating system rather than a runtime
Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
1-
# CuOS Quickstart
1+
# Getting to know CuOS
22

3-
A minimal end-to-end walkthrough to build, boot and update a CuOS based system.
3+
Build one, boot it, then take it apart: update it, patch it, break it, roll it
4+
back. By the end you will have used every mechanism CuOS has, on a machine you
5+
can throw away.
46

5-
> Audience: Engineers who want to try CuOS quickly (Variant 2 or 3 style) without reading all reference docs first.
6-
>
7-
> Prerequisites: Linux/macOS build host, Docker, `jq`, ~6 GB free disk space, a VM platform (QEMU/VirtualBox/Proxmox) or spare USB device.
7+
> Prerequisites: Linux/macOS build host, Docker, `jq`, ~6 GB free disk space, a VM platform (QEMU/VirtualBox/Proxmox) or spare USB device. Allow an hour.
88
9-
> **If you only want a running system**, you do not need this repository. Clone
9+
> **This is not the fast way to a running system.** For that you do not need
10+
> this repository at all: clone
1011
> [cuos-release](https://github.com/cuos-dev/cuos-release), write a
11-
> `system.json` and run `./cuos-release/tool.sh image` — its README walks you
12-
> through it. This page is for looking inside afterwards.
12+
> `system.json`, run `./cuos-release/tool.sh image` — its README is three
13+
> commands long. Come back here when you want to know what you just built.
1314
1415
---
1516

0 commit comments

Comments
 (0)