walkero
/
lite-xl
1
0
Fork 0
Code Issues 7 Pull Requests Projects Releases 14 Wiki Activity

Add release flag for meson setup in README

This commit is contained in:
Francesco 2021-04-14 23:50:33 +02:00 committed by GitHub
parent 6fb7ecbe96
commit 9c0a4a46c5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -66,7 +66,7 @@ sudo apt install meson
To build Lite XL with Meson the commands below can be used:
```sh
meson setup build
meson setup --buildtype=release build
meson compile -C build
meson install -C build
```
@ -74,18 +74,19 @@ meson install -C build
If you are using a version of Meson below 0.54 you need to use diffent commands to compile and install:
```sh
meson setup build
meson setup --buildtype=release build
ninja -C build
ninja -C build install
```
When performing the `meson setup` command you may enable the `-Dportable=true` option to specify whether a portable build should be done.
When performing the `meson setup` command you may enable the `-Dportable=true` option to specify whether files should be installed as in a portable application.
If `portable` is enabled, Lite XL is built to use `data` and `user` directories placed next to the executable.
Otherwise, Lite XL will use Unix-like directory locations.
In this case, the `data` directory will be located in `$prefix/share/lite-xl`, and the `user`
directory will be `$HOME/.config/lite-xl`.
`$prefix` is determined such that `$prefix/bin` corresponds to the location of the executable.
If `portable` is enabled, Lite XL is built to use a `data` directory placed next to the executable.
Otherwise, Lite XL will use unix-like directory locations.
In this case, the `data` directory will be `$prefix/share/lite-xl` and the executable will be located in `$prefix/bin`.
`$prefix` is determined when the application starts as a directory such that `$prefix/bin` corresponds to the location of the executable.
The `user` directory does not depend on the `portable` option and will always be `$HOME/.config/lite-xl`.
`$HOME` is determined from the corresponding environment variable.
As a special case on Windows the variable `$USERPROFILE` will be used instead.