|
||
---|---|---|
.github/workflows | ||
.travis | ||
.tx | ||
src | ||
ui | ||
.gitignore | ||
banner.png | ||
bootstrap.linux.toml | ||
bootstrap.macos.toml | ||
bootstrap.windows.toml | ||
build.rs | ||
Cargo.lock | ||
Cargo.toml | ||
config.linux.v1.toml | ||
config.linux.v2.toml | ||
config.linux.v3.toml | ||
config.windows.v2.toml | ||
config.windows.v3.toml | ||
config.windows.v4.toml | ||
config.windows.v5.toml | ||
config.windows.v6.toml | ||
config.windows.v7.toml | ||
config.windows.v8.toml | ||
config.windows.v9.toml | ||
config.windows.v10.toml | ||
Justfile | ||
LICENSE | ||
liftinstall.png | ||
README.md | ||
SECURITY.md |
![](/yuzu/liftinstall/media/branch/master/banner.png)
Usage Documentation - Quick Start - License
An installer for your application. Designed to be customisable to the core, hookable from external applications, and have a decent UI.
This is designed to be a more modern interpretation of Qt's Installer Framework, which is hard to develop on, poorly documented, has a hardcoded package listing format, and isn't supported all that well, with rare updates and a large list of bugs.
Building
For more detailed instructions, look at the usage documentation above.
There are are few system dependencies depending on your platform:
- For all platforms,
cargo
should be available on your PATH. Rustup is the recommended way to achieve this. Stable or Nightly Rust works fine. - Have node.js and Yarn available on your PATH (for building UI components, not needed at runtime).
- For Windows (MSVC), you need Visual Studio installed.
- For Windows (Mingw), you need
gcc
/g++
available on the PATH. - For Mac, you need Xcode installed, and Clang/etc available on the PATH.
- For Linux, you need
gcc
/g++
,webkit2gtk
, andlibssl
. For Ubuntu 18.04 this would look like:
apt install -y build-essential libwebkit2gtk-4.0-dev libssl-dev
In order to build yourself an installer, as a bare minimum, you need to:
- Add your favicon to
ui/public/favicon.ico
- Add your logo to
ui/src/assets/logo.png
- Modify the bootstrap configuration file as needed (
config.PLATFORM.toml
). - Have the main configuration file somewhere useful, reachable over HTTP.
- Run:
cargo build --release
Contributing
PRs are very welcome. Code should be run through Rustfmt before submission.
License
LiftInstall is licensed under the Apache 2.0 License, which can be found in LICENSE.