liftinstall/README.md

41 lines
1.2 KiB
Markdown
Raw Normal View History

2018-01-31 04:42:28 +01:00
LiftInstall
===========
2018-01-31 07:14:31 +01:00
[![Build Status](https://travis-ci.org/j-selby/liftinstall.svg?branch=master)](https://travis-ci.org/j-selby/liftinstall)
- Usage Documentation: https://liftinstall.jselby.net/
2018-01-31 04:43:49 +01:00
An installer for your application. Designed to be customisable to the core, hookable from external
2018-01-31 04:42:28 +01:00
applications, and have a decent UI.
This is designed to be a more modern interpretation of Qt's Installer Framework, which has several issues:
- Hard to develop on and poorly documented
- Hardcoded package listing format, requires very specific setups for packages, packages must be built
using their tool
- Poorly supported, with rare updates and a large list of bugs
Building
--------
- Add your favicon to `static/favicon.ico`
- Modify the configuration file as needed
- Tweak `package.metadata.winres` metadata in `Cargo.toml`
- Run:
2018-01-31 04:42:28 +01:00
```bash
cargo build --release
2018-01-31 04:42:28 +01:00
```
LiftInstall should build on both Stable and Nightly Rust.
2018-01-31 07:14:31 +01:00
Contributing
------------
PRs are very welcome. Code should be run through [Rustfmt](https://github.com/rust-lang-nursery/rustfmt)
before submission.
2018-01-31 04:42:28 +01:00
License
-------
2018-01-31 04:43:49 +01:00
LiftInstall is licensed under the Apache 2.0 License, which can be found in [LICENSE](LICENSE).