Skip to content

Improve documentation formatting and consistency #633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pickle-RickA wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve documentation formatting and consistency #633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions examples/ctr-example/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ You should now see the `vmlinux` image in examples/ctr-example

### 2. Build/Run ctr-example

From examples/ctr-example run
`make all`
From examples/ctr-example run:
```bash
make all
```

> [!WARNING]
> If you get the following error, try building from the default macOS terminal:
Expand Down
2 changes: 1 addition & 1 deletion examples/ctr-example/lab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This'll install your kernel.

After this start your first container. On first launch, this'll install another artifact for our guest init process:

```
```bash
container run alpine uname
```

Expand Down
2 changes: 1 addition & 1 deletion kernel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This directory includes an optimized kernel configuration to produce a fast and lightweight kernel for container use.

- `config-arm64` includes the kernel `CONFIG_` options.
- `Makefile` includes the kernel version and source package url.
- `Makefile` includes the kernel version and source package URL.
- `build.sh` scripts the kernel build process.
- `image/` includes the configuration for an image with build tooling.

Expand Down