Provide a quick offline build guide in README.md
This commit is contained in:
parent
205b52b08a
commit
2fdde9cc99
28
README.md
28
README.md
|
@ -11,7 +11,7 @@ A lightweight text editor written in Lua, adapted from [lite].
|
|||
* **[Get color themes]** — Add additional colors themes.
|
||||
|
||||
Please refer to our [website] for the user and developer documentation,
|
||||
including [build] instructions.
|
||||
including [build] instructions details. A quick build guide is described below.
|
||||
|
||||
Lite XL has support for high DPI display on Windows and Linux and,
|
||||
since 1.16.7 release, it supports **retina displays** on macOS.
|
||||
|
@ -42,6 +42,32 @@ the [plugins repository] or in the [Lite XL plugins repository].
|
|||
Additional color themes can be found in the [colors repository].
|
||||
These color themes are bundled with all releases of Lite XL by default.
|
||||
|
||||
## Quick Build Guide
|
||||
|
||||
If you compile Lite XL yourself, it is recommended to use the script
|
||||
`build-packages.sh`:
|
||||
|
||||
```sh
|
||||
bash build-packages.sh <arch>
|
||||
```
|
||||
|
||||
The script will run Meson and create a zip file with the application or,
|
||||
for Linux, a tar compressed archive. Lite XL can be easily installed
|
||||
by unpacking the archive in any directory of your choice.
|
||||
|
||||
Otherwise the following is an example of basic commands if you want to customize
|
||||
the build:
|
||||
|
||||
```sh
|
||||
meson setup --buildtype=release --prefix <prefix> build
|
||||
meson compile -C build
|
||||
DESTDIR="$(pwd)/lite-xl" meson install --skip-subprojects -C build
|
||||
```
|
||||
|
||||
where `<prefix>` might be one of `/`, `/usr` or `/opt`, the default is `/usr/local`.
|
||||
Please note that the package is relocatable to any prefix and the option prefix
|
||||
affects only the place where the application is actually installed.
|
||||
|
||||
## Contributing
|
||||
|
||||
Any additional functionality that can be added through a plugin should be done
|
||||
|
|
Loading…
Reference in New Issue