Skip to content

Commit

Permalink
doc: update README.md with the latest UI changes
Browse files Browse the repository at this point in the history
Signed-off-by: Andrea Righi <[email protected]>
  • Loading branch information
Andrea Righi committed Oct 9, 2023
1 parent d18d080 commit 0917392
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ Quick start
$ git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
$ cd linux
$ vng --build --commit v6.2-rc4
...
$ vng --run
_ _
__ _(_)_ __| |_ _ __ ___ ___ _ __ __ _
\ \ / / | __| __| _ _ \ / _ \_____| _ \ / _ |
Expand Down Expand Up @@ -103,13 +105,13 @@ Examples
$ vng -r ./arch/x86/boot/bzImage
```

- Test the currently running kernel in a safe snapshot of the system:
- Test the kernel recompiled in the current working directory:
```
$ vng -r
```

- Test installed kernel 6.2.0-21-generic kernel in a safe snapshot of the
system (NOTE: /boot/vmlinuz-6.2.0-21-generic needs to be accessible):
- Test installed kernel 6.2.0-21-generic kernel
(NOTE: /boot/vmlinuz-6.2.0-21-generic needs to be accessible):
```
$ vng -r 6.2.0-21-generic
```
Expand All @@ -136,7 +138,8 @@ Examples
--build-host-exec-prefix "schroot -c chroot:kinetic-amd64 -- "
```

- Run the previously compiled kernel and enable networking:
- Run the previously compiled kernel from the current working directory and
enable networking:
```
$ vng -r . --network user
```
Expand All @@ -153,8 +156,8 @@ Examples
$ vng --build RUSTC=rustc-1.62 BINDGEN=bindgen-0.56 RUSTFMT=rustfmt-1.62
```

- Build and test the arm64 kernel (using a separate chroot in
/opt/chroot/arm64 as the main filesystem):
- Build the arm64 kernel (using a separate chroot in /opt/chroot/arm64 as the
main filesystem):
```
$ vng --build --arch arm64 --root /opt/chroot/arm64/
```
Expand Down Expand Up @@ -216,8 +219,8 @@ Examples
(virtme-ng is started in graphical mode)
```

- Run the `steam` snap inside a virtme-ng instance using the
6.2.0-1003-lowlatency kernel:
- Run the `steam` snap (tested in Ubuntu) inside a virtme-ng instance using
the 6.2.0-1003-lowlatency kernel:
```
$ vng -r 6.2.0-1003-lowlatency --snaps --net user -g /snap/bin/steam
Expand All @@ -230,7 +233,8 @@ Implementation details
virtme-ng allows to automatically configure, build and run kernels using the
main command-line interface called `vng`.

A minimal custom `.config` is automatically generated if not already present.
A minimal custom `.config` is automatically generated if not already present
when --build is specified.

It is possible to specify a set of custom configs (.config chunk) in
`~/.config/virtme-ng/kernel.config`, these user-specific settings will override
Expand Down

0 comments on commit 0917392

Please sign in to comment.