Skip to content

Commit 60307ea

Browse files
author
Adam McKee
committed
tweak examples docs
1 parent dc68c16 commit 60307ea

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

examples/README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
## Cloud VMs
44

5-
Many cloud providers support launchingVMs from their JavaScript SDKs which
6-
allows `c2` to integrate directly into your DevOps Infrastructure as Code
7-
workflows.
5+
Many cloud providers support launching VMs from their JavaScript SDKs.
6+
This allows `c2` to integrate directly into your DevOps workflows.
87

9-
The TypeScript examples will require `bun i` or `pnpm i` in this dir before
10-
running.
8+
The TypeScript examples will require `bun i` or `pnpm i` in this directory
9+
before running.
1110

1211
### linode.ts
1312

@@ -27,16 +26,18 @@ tweaked for your OS architecture.
2726

2827
Exit the QEMU VM with ctrl + a, release ctrl, press x.
2928

30-
These scripts will run the globally installed `c2` or will run a released
31-
version of `c2` via `npx`. Run either script with `--dev` to build and run
32-
from the cloned repo sources.
33-
3429
### qemu_http.sh
3530

36-
Ubuntu inits with an HTTP datasource to `c2` running an HTTP server in the
37-
background with the command `c2 cloud-init --http 8202`.
31+
Ubuntu inits with an HTTP datasource with `c2` running an HTTP server in the
32+
background using the command `c2 cloud-init --http 8202`.
3833

3934
### qemu_iso.sh
4035

41-
`genisoimage` or `hdiutil` make an ISO medium of the `cloud-init` built with
42-
`c2 cloud-init`.
36+
`genisoimage` or `hdiutil` make an ISO medium of the `cloud-init` directory
37+
built with `c2 cloud-init`.
38+
39+
### Using local dev changes
40+
41+
These scripts will run the globally installed `c2` or will run a released
42+
version of `c2` via `npx`. Run either script with `--dev` to build and run
43+
from the cloned repo sources.

0 commit comments

Comments
 (0)