README.md - Add Getting started section #29
Conversation
Arxcis
changed the title
| @@ -0,0 +1 @@ | |||
| build/ | |||
There was a problem hiding this comment.
This doesn't need to be here, really, as the name of the build directory is user-controlled, it could be anything (even if that one matches the instructions in the README).
There was a problem hiding this comment.
Side note: recent versions of Meson will automatically generate a .gitignore in the build directory.
|
|
||
| ### Build libportal | ||
| ``` | ||
| meson build/libportal |
There was a problem hiding this comment.
Why use subdirectories? We usually prefer _build to make it clear that it's not a command on its own.
|
|
||
| ### Build and run portal-test | ||
| ``` | ||
| meson build/potal-test -Dbuild-portal-test=true |
There was a problem hiding this comment.
Ditto about the sub-directories here. There was a typo in the subdir name.
| meson build/doc -Dgtk_doc=true | ||
| ninja -C build/doc | ||
|
|
||
| # @TODO How to view the docs? |
There was a problem hiding this comment.
gio open build/doc/doc/html/index.html in your example.
| ``` | ||
| meson build/potal-test -Dbuild-portal-test=true | ||
| ninja -C build/portal-test | ||
| chmod +x ./build/potal-test/portal-test/portal-test |
There was a problem hiding this comment.
That shouldn't be needed, it's a compiled executable, it should already be executable.
Based on #29, but a bit expanded and hopefully addressing concerns on that PR. Omits docs instructions for now as I'm not familiar with how that works.
Based on flatpak#29, but a bit expanded and hopefully addressing concerns on that PR. Omits docs instructions for now as I'm not familiar with how that works.
|
|
||
| ### Build libportal | ||
| ``` | ||
| meson build/libportal |
There was a problem hiding this comment.
The idiomatic command is:
meson setup _build
| ### Build and run portal-test | ||
| ``` | ||
| meson build/potal-test -Dbuild-portal-test=true | ||
| ninja -C build/portal-test |
There was a problem hiding this comment.
| ninja -C build/portal-test | |
| meson compile -C _build |
|
|
||
| ### Build and view docs | ||
| ``` | ||
| meson build/doc -Dgtk_doc=true |
There was a problem hiding this comment.
| meson build/doc -Dgtk_doc=true | |
| meson setup -Dgtk_doc=true _build |
| ### Build and view docs | ||
| ``` | ||
| meson build/doc -Dgtk_doc=true | ||
| ninja -C build/doc |
There was a problem hiding this comment.
| ninja -C build/doc | |
| meson compile -C _build |
| ### Build libportal | ||
| ``` | ||
| meson build/libportal | ||
| ninja -C build/libportal |
There was a problem hiding this comment.
| ninja -C build/libportal | |
| meson compile -C _build |
Why?
Added
TODO