Skip to content

Commit a846095

Browse files
committed
Refine the prerequisites for backends
1 parent 0c898a0 commit a846095

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,16 @@ benefiting the entire application stack.
6565
`Mado` is built with a minimalist design in mind. However, its verification
6666
relies on certain third-party packages for full functionality and access to all
6767
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),
69-
and the [SDL2 library](https://www.libsdl.org/).
68+
packages, including [libjpeg](https://www.ijg.org/) and [libpng](https://github.com/pnggroup/libpng).
69+
70+
In the meantime, ensure that you choose a graphics backend and install the necessary packages beforehand.
71+
72+
For SDL backend, install the [SDL2 library](https://www.libsdl.org/).
7073
* macOS: `brew install sdl2 jpeg libpng`
7174
* Ubuntu Linux / Debian: `sudo apt install libsdl2-dev libjpeg-dev libpng-dev`
7275

73-
Please note that the VNC backend is only tested on GNU/Linux, and the prebuilt [neatvnc](https://github.com/any1/neatvnc) package might be outdated. To ensure you have the latest versions, you can build the dependent packages from source by running the script:
74-
```bash
76+
For the VNC backend, please note that it has only been tested on GNU/Linux, and the prebuilt [neatvnc](https://github.com/any1/neatvnc) package might be outdated. To ensure you have the latest version, you can build the required packages from source by running the script:
77+
```shell
7578
$ tools/build-neatvnc.sh
7679
```
7780

0 commit comments

Comments
 (0)