Skip to content

Commit

Permalink
Mention Linux framebuffer mode in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shengwen-tw committed Jul 24, 2024
1 parent fc00614 commit 4c2376f
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,28 @@ Build the library and demo program.
$ make
```

Run sample `Mado` program:
`Mado` supports SDL or Linux framebuffer as backends. The basic usage is given as:

```shell
$ ./demo-sdl
$ ./demo -b backend [-p fb-path]
```

For example, to run `Mado` with SDL as backend:

```
$ ./demo -b sdl
```

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

To run `Mado` with Linux framebuffer as backend, type:

```
$ ./demo -b fb -p /dev/fb0
```

Note that the user may require to execute `Mado` with `sudo` command with Linux framebuffer mode.

## License

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

0 comments on commit 4c2376f

Please sign in to comment.