yuzu-emu/liftinstall
1
0
Fork 0
mirror of https://github.com/yuzu-emu/liftinstall.git synced 2024-11-25 17:05:39 +01:00
Code Issues Packages Projects Releases Wiki Activity
An adaptable installer for your application
189 Commits 1 Branch 9 Tags 2.2 MiB
Rust 73%
Vue 17.9%
JavaScript 6%
C++ 2.2%
HTML 0.5%
Other 0.4%
713b85b59a
Go to file
liushuyu 713b85b59a lint: automated lint
2019-12-07 22:35:37 +00:00
.github/workflows Remove Ubuntu/macOS targets in Github Actions 2019-08-27 05:23:33 +00:00
.travis build: integrate webpack building into build.rs 2019-06-25 15:44:41 +08:00
src lint: automated lint 2019-12-07 22:35:37 +00:00
ui lint: automated lint 2019-12-07 22:35:37 +00:00
.gitignore Use proper logging solution 2018-08-04 16:28:13 +10:00
.travis.yml travis: add cache and fix issues 2019-06-29 16:17:58 +00:00
banner.png Clean up documentation 2018-08-09 17:06:20 +10:00
bootstrap.linux.toml Use "bootstrap" as part of filename for bootstrap configuration files 2018-09-20 13:37:44 +10:00
bootstrap.macos.toml travis: add macos and windows CI 2019-04-03 00:57:27 -06:00
bootstrap.windows.toml Add mechanism to hide advanced menu from config 2018-10-01 11:52:48 +10:00
build.rs lint: automated lint 2019-12-07 22:35:37 +00:00
Cargo.lock deps: update dependencies 2019-12-07 22:35:37 +00:00
Cargo.toml deps: update dependencies 2019-12-07 22:35:37 +00:00
LICENSE Add readme and license 2018-01-31 14:42:28 +11:00
liftinstall.png Add logo 2018-08-09 15:50:38 +10:00
README.md Add instructions for node + yarn 2019-06-26 23:44:17 +10:00

README.md

Usage Documentation - Quick Start - License

Build Status

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, and libssl. 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.