aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5700b02..6d13985 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,24 @@ Can be used by a package manager plugin that works from inside the editor and ca
Releases forthcoming, should be available on Windows, Mac, Linux and FreeBSD.
+## Quickstart
+
+If you have a C compiler, and `git`, and want to compile from scratch, you can do:
+
+```
+git clone git@github.com:adamharrison/lite-xl-plugin-manager.git --shallow-submodules \
+ --recurse-submodules && cd lite-xl-plugin-manager && ./build.sh && ./lpm
+````
+
+If you want to build it quickly, and have the right modules installed, you can do:
+
+```
+./build.sh -lz -lssl -llibgit2
+```
+
+CI is enabled on this repository, so you can grab Windows and Linux builds from the
+`continuous` [release page](https://github.com/adamharrison/lite-xl-plugin-manager/releases/tag/continuous).
+
## Usage
```sh
@@ -17,3 +35,17 @@ lpm add https://github.com/lite-xl/lite-xl-plugins.git
lpm rm https://github.com/lite-xl/lite-xl-plugins.git
```
+
+## Building
+
+### Linux
+
+```
+./build.sh -DLPM_VERSION='"'$VERSION-x86_64-linux-`git rev-parse --short HEAD`'"'
+```
+
+### Linux to Windows
+
+```
+CC=x86_64-w64-mingw32-gcc AR=x86_64-w64-mingw32-gcc-ar WINDRES=x86_64-w64-mingw32-windres GIT2_CONFIGURE="-DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER -DCMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY -DCMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY -DBUILD_CLAR=OFF -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_SYSTEM_NAME=Windows -DDLLTOOL=x86_64-w64-mingw32-dlltool" SSL_CONFIGURE=mingw ./build.sh -DLPM_VERSION='"'$VERSION-x86_64-linux-`git rev-parse --short HEAD`'"'
+```