Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kernel-cyrus authored May 16, 2024
1 parent f6df997 commit fb3a9c1
Showing 1 changed file with 23 additions and 5 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ sudo apt install gcc-aarch64-linux-gnu

gdb and qemu are already built as binaries. lightbox will just use the prebuild ones, and nothing else is needed.

**for ARM64 Host**
**for arm64 Host**

When your host is arm64 (raspberry pi or macbook m1), you need install GDB and QEMU:

Expand All @@ -48,9 +48,23 @@ sudo apt install gdb
sudo apt install qemu qemu-system-arm
```

**Install tmux**

For better experience, lightbox will use tmux as default terminal when it is installed.

To install tmux:

```
sudo apt install tmux
```

When tmux is not installed, lightbox will use gnome as default termninal, you can also choose to use xfce4 or cli terminal seperately.

**Install DDD**

Lightbox support use ddd as graphic debugger, you need install it if you want to use it:
By default, lightbox use gdb as default debugger with tui. You can also choose to use ddd as debugger with gui.

To install ddd:

```
sudo apt install ddd
Expand Down Expand Up @@ -110,6 +124,8 @@ Start Kernel
--with=<"gdb" or "ddd"> # use gdb or ddd as debugger (OPTIONAL)
--append=<kernel cmdline> # append extra cmdline (OPTIONAL)
--share=<share folder path> # host share folder (OPTIONAL)
--terminal=<terminal to use> # default: tmux (OPTIONAL)
# options: tmux / gnome / xfce4 / cli-qemu / cli-gdb
```
**Run kernel with gdb**
```
Expand Down Expand Up @@ -138,17 +154,19 @@ You can also use a custom share folder:
./start-kernel --kernel=<kernel_dir> --share="./host-share"
```

**Support for gnome and xfce4 terminal**
**Support for gnome and xfce4 terminals**

When tmux is not installed, lightbox will use gnome as default terminal.

By default, lightbox uses gnome terminal, in some cases you may choose to use xfce4 terminal:
In some cases when your host os is not GNOME, you may choose to use xfce4 terminal:

```
./start-kernel --kernel=<kernel_dir> --terminal="xfce4"
```

**Run in cli mode**

For pure cli environment like ssh without desktop display, you can start qemu and gdb seperately.
For pure cli environment like ssh without desktop display, and also tmux is not installed, you can start qemu and gdb seperately.

Start qemu from one cli session:

Expand Down

0 comments on commit fb3a9c1

Please sign in to comment.