Changed Readme
This commit is contained in:
parent
028b33fecb
commit
1d7c7ce245
1 changed files with 45 additions and 4 deletions
43
README.md
43
README.md
|
@ -1,5 +1,46 @@
|
|||
# kavita-upload-helper
|
||||
# Kavita Upload Helper
|
||||
|
||||
Tool for easily uploading new chapters/series to a Kavita server.
|
||||
|
||||
Requires sftp access to the Kavita library directories as well as Kavita Admin access.
|
||||
|
||||
# Slint Rust Template
|
||||
|
||||
A template for a Rust application that's using [Slint](https://slint.rs) for the user interface.
|
||||
|
||||
## About
|
||||
|
||||
This template helps you get started developing a Rust application with Slint as toolkit
|
||||
for the user interface. It demonstrates the integration between the `.slint` UI markup and
|
||||
Rust code, how to trigger react to callbacks, get and set properties and use basic widgets.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Install Rust by following the [Rust Getting Started Guide](https://www.rust-lang.org/learn/get-started).
|
||||
Once this is done, you should have the ```rustc``` compiler and the ```cargo``` build system installed in your path.
|
||||
2. Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate)
|
||||
```
|
||||
cargo install cargo-generate
|
||||
```
|
||||
3. Set up a sample project with this template
|
||||
```
|
||||
cargo generate --git https://github.com/slint-ui/slint-rust-template --name my-project
|
||||
cd my-project
|
||||
```
|
||||
3. Build with cargo
|
||||
```
|
||||
cargo build
|
||||
```
|
||||
4. Run the application binary
|
||||
```
|
||||
cargo run
|
||||
```
|
||||
|
||||
We recommend using an IDE for development, along with our [LSP-based IDE integration for `.slint` files](https://github.com/slint-ui/slint/blob/master/tools/lsp/README.md). You can also load this project directly in [Visual Studio Code](https://code.visualstudio.com) and install our [Slint extension](https://marketplace.visualstudio.com/items?itemName=Slint.slint).
|
||||
|
||||
## Next Steps
|
||||
|
||||
We hope that this template helps you get started and you enjoy exploring making user interfaces with Slint. To learn more
|
||||
about the Slint APIs and the `.slint` markup language check out our [online documentation](https://slint.dev/docs).
|
||||
|
||||
Don't forget to edit this README to replace it by yours
|
||||
|
|
Loading…
Reference in a new issue