Skip to content

Commit 888355f

Browse files
committed
Mention sample program execution with Linux framebuffer in README.md
1 parent 414ac6b commit 888355f

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,14 @@ benefiting the entire application stack.
5858
`Mado` is built with a minimalist design in mind. However, its verification
5959
relies on certain third-party packages for full functionality and access to all
6060
its features. To ensure proper operation, the development environment should
61-
have the [SDL2 library](https://www.libsdl.org/), [libjpeg](https://www.ijg.org/), and [libpng](https://github.com/pnggroup/libpng) installed.
61+
have the [libjpeg](https://www.ijg.org/), and [libpng](https://github.com/pnggroup/libpng) installed.
62+
The [SDL2 library](https://www.libsdl.org/) is optional and only needed if the
63+
user chooses to use SDL as the backend over the Linux framebuffer.
6264
* macOS: `brew install sdl2 jpeg libpng`
6365
* Ubuntu Linux / Debian: `sudo apt install libsdl2-dev libjpeg-dev libpng-dev`
6466

65-
Configure via [Kconfiglib](https://pypi.org/project/kconfiglib/)
67+
Configure via [Kconfiglib](https://pypi.org/project/kconfiglib/), you should select either SDL
68+
video output or the Linux framebuffer.
6669
```shell
6770
$ make config
6871
```
@@ -72,13 +75,20 @@ Build the library and demo program.
7275
$ make
7376
```
7477

75-
Run sample `Mado` program:
78+
Run sample `Mado` program with SDL backend:
7679
```shell
7780
$ ./demo-sdl
7881
```
7982

8083
Once the window appears, you should be able to move the windows and interact with the widgets.
8184

85+
Run sample `Mado` program with the Linux framebuffer backend:
86+
```shell
87+
$ sudo FRAMEBUFFER=/dev/fb0 ./demo-fbdev
88+
```
89+
90+
If the `FRAMEBUFFER` environment variable is not set, `Mado` will use `/dev/fb0` by default.
91+
8292
## License
8393

8494
`Mado` is available under a MIT-style license, permitting liberal commercial use.

0 commit comments

Comments
 (0)