Review compositor tutorial #3606
Conversation
There was a problem hiding this comment.
Do you think the build definition of Cmake requires more explanations? Or will it be a self-evident thing for a regular C++ developer?
CMake is the de facto standard for C++ development. It is also fairly self explanatory: developers accustomed to different tooling will be able to extract the details they need.
| ## Running a Mir composer | ||
| You can run a composer nested in an X or Wayland session, or from a virtual terminal, just like the demo applications in [Getting started with Mir](learn-what-mir-can-do.md). | ||
|
|
||
| For example, to run inside an existing Wayland session: | ||
| ```sh | ||
| WAYLAND_DISPLAY=wayland-99 ./build/demo-mir-compositor |
There was a problem hiding this comment.
To the uninitiated like me, wayland-99 seems like a magic number. Maybe it can get a note or a comment?
There was a problem hiding this comment.
Usually, Wayland compositors use wayland-0 (or wayland-1, wayland-2, ... if you're running multiple compositors). This is used as the name of the compositor's socket which two compositors cannot share (as far as I know). So wayland-99 is just a convention we use in the team to not have to worry about that.
Co-authored-by: Artem Konev <[email protected]> Co-authored-by: Alan Griffiths <[email protected]>
| ## Installing dependencies | ||
|
|
||
| The example program requires | ||
| * `libmiral`- a library for Mir abstraction layer |
There was a problem hiding this comment.
Some suggestions: (looks like I misclicked something when starting the review :))
Co-authored-by: tarek-y-ismail <[email protected]>
Co-authored-by: tarek-y-ismail <[email protected]>
Co-authored-by: tarek-y-ismail <[email protected]>
Co-authored-by: tarek-y-ismail <[email protected]>
Co-authored-by: Alan Griffiths <[email protected]>
Another docs review. I've provided a bit more context to the code creation part (at least as well as I myself could understand it).
Do you think the build definition of Cmake requires more explanations? Or will it be a self-evident thing for a regular C++ developer?
Jira: https://warthogs.atlassian.net/browse/DOCPR-852