diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 32 insertions, 19 deletions
@@ -1,26 +1,40 @@ # Lite XL Plugin Manager -My attempt at a lite-xl plugin manager. A standalone binary that provides an easy way of installing, and uninstalling plugins from lite-xl. +A standalone binary that provides an easy way of installing, and uninstalling +plugins from lite-xl, as well as different version fo lite-xl. -Can be used by a package manager plugin that works from inside the editor and calls this. +Can be used by a package manager plugin that works from inside the editor +and calls this binary. Releases forthcoming, should be available on Windows, Mac, Linux and FreeBSD. -Also contains a plugin_manager.lua plugin to integrate the binary with lite in the form of an easy-to-use GUI. +Also contains a plugin_manager.lua plugin to integrate the binary with lite in +the form of an easy-to-use GUI. + +By default, `lpm` will automatically consume the specification in the `latest` +branch of this repository. + +## Specification + +For details about the `manifest.json` files that `lpm` consumes, +[see here](SPEC.md). ## Quickstart -If you have a C compiler, and `git`, and want to compile from scratch, you can do: +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 +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: +If you want to build it quickly, and have the right modules installed, you can +do: ``` -./build.sh -lz -lssl -lgit2 -lcurl -lcrypto -llua +./build.sh -larchive -llzma -lz -lssl -lgit2 -lz -lcurl -lcrypto -llua ``` CI is enabled on this repository, so you can grab Windows and Linux builds from the @@ -30,9 +44,11 @@ You can get a feel for how to use `lpm` by typing `./lpm --help`. ## Supporting Libraries -Unlike lite, due to the precense of the beast of a library that is OpenSSL, I've made no attempt to limit the amount -of libraries being linked in here, I'm only ensuring that everything can be linked statically as much as possible. As -seen with the `lib` folder, the following external libraries are used to build `lpm`: +Unlike lite, due to the precense of the beast of a library that is OpenSSL, +I've made no attempt to limit the amount of libraries being linked in here, +I'm only ensuring that everything can be linked statically as much as possible. +As seen with the `lib` folder, the following external libraries are used to +build `lpm`: * lua (core program written in) * OpenSSL (https/SSL support) @@ -47,24 +63,20 @@ seen with the `lib` folder, the following external libraries are used to build ` To make pre-fab lite builds, you can easily use `lpm` in CI. If you had a linux build container, you could do something like: ```sh - curl https://github.com/adamharrison/lite-xl-plugin-manager/releases/download/v0.1/lpm.x86_64-linux > lpm export LITE_USERDIR=lite-xl/data && export LPM_CACHE=/tmp/cache ./lpm add https://github.com/adamharrison/lite-xl-plugin-manager && ./lpm install plugin_manager lsp - ``` ## Usage ```sh - -lpm update && lpm install aligncarets +lpm install aligncarets lpm uninstall aligncarets +``` -lpm add https://github.com/adamharrison/lite-xl-plugin-manager.git -lpm install plugin_manager -lpm rm https://github.com/adamharrison/lite-xl-plugin-manager.git - +```sh +lpm --help ``` ## Building @@ -80,3 +92,4 @@ lpm rm https://github.com/adamharrison/lite-xl-plugin-manager.git ``` CC=x86_64-w64-mingw32-gcc AR=x86_64-w64-mingw32-gcc-ar WINDRES=x86_64-w64-mingw32-windres LZMA_CONFIGURE="--host=x86_64-w64-mingw32" ARCHIVE_CONFIGURE="-DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER -DCMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY -DCMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_SYSTEM_NAME=Windows" CURL_CONFIGURE="-DCMAKE_FIND_ROOT_PATH_MODE_PROGRAM=NEVER -DCMAKE_FIND_ROOT_PATH_MODE_LIBRARY=ONLY -DCMAKE_FIND_ROOT_PATH_MODE_INCLUDE=ONLY -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_SYSTEM_NAME=Windows" 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-windows-`git rev-parse --short HEAD`'"' ``` + |