You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+29-5Lines changed: 29 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -60,30 +60,54 @@ benefiting the entire application stack.
60
60
61
61
## Build and Verify
62
62
63
+
### Prerequisites
64
+
63
65
`Mado` is built with a minimalist design in mind. However, its verification
64
66
relies on certain third-party packages for full functionality and access to all
65
-
its features. To ensure proper operation, the development environment should
66
-
have the [SDL2 library](https://www.libsdl.org/), [libjpeg](https://www.ijg.org/), and [libpng](https://github.com/pnggroup/libpng) installed.
67
+
its features. We encourage the development environment to be installed with all optional
68
+
packages, including [libjpeg](https://www.ijg.org/), [libpng](https://github.com/pnggroup/libpng),
Configure via [Kconfiglib](https://pypi.org/project/kconfiglib/)
73
+
### Configuration
74
+
75
+
Configure via [Kconfiglib](https://pypi.org/project/kconfiglib/), you should select either SDL
76
+
video output or the Linux framebuffer.
71
77
```shell
72
78
$ make config
73
79
```
74
80
75
-
Build the library and demo program.
81
+
### Build and execution
82
+
83
+
Build the library and demo program:
84
+
76
85
```shell
77
86
$ make
78
87
```
79
88
80
-
Run sample `Mado` program:
89
+
To run demo program with SDL backend:
90
+
81
91
```shell
82
92
$ ./demo-sdl
83
93
```
84
94
85
95
Once the window appears, you should be able to move the windows and interact with the widgets.
86
96
97
+
To run demo program with the Linux framebuffer backend:
98
+
99
+
```shell
100
+
$ sudo ./demo-fbdev
101
+
```
102
+
103
+
Normal users don't have access to `/dev/fb0` so require `sudo`. Alternatively, you can add the user to the video group to avoid typing `sudo` every time:
104
+
105
+
```shell
106
+
$ sudo usermod -a -G video $USERNAME
107
+
```
108
+
109
+
In addition, the framebuffer device can be assigned via the environment variable `FRAMEBUFFER`.
110
+
87
111
## License
88
112
89
113
`Mado` is available under a MIT-style license, permitting liberal commercial use.
0 commit comments