Skip to content

Commit

Permalink
readme: improve text of readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ahayzen-kdab committed Mar 15, 2024
1 parent b331c83 commit 20ac6af
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 17 deletions.
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ glow = "0.12.2"
raw-window-handle = "0.5"
url = "2.3"

# Note that we cannot run cargo update on the lock file
# instead copy the lock file from the servo repository
# then cargo run will add the missing dependencies to the lock file
libservo = { git = "https://github.com/servo/servo.git", rev = "3a3e76a935f92ce84c24496cfc46207cd46088f6" }
servo-media = { git = "https://github.com/servo/media" }
surfman = { version = "0.9", features = ["chains", "sm-angle", "sm-angle-default"] }
Expand Down
44 changes: 27 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,33 +7,43 @@ SPDX-License-Identifier: MPL-2.0

# Servo WebView for Qt using CXX-Qt

TODO
KDAB has built a demo of using [CXX-Qt](https://github.com/KDAB/cxx-qt/) to expose a [Servo](https://servo.org/) in Rust as a component to Qt.

# Setup
## Setup

We need the nightly compiler for now.
* Ensure that you have Qt installed and `qmake` in your `PATH`.
* Ensure that you have the dependencies of `./mach boostrap` from the [https://github.com/servo/servo/](https://github.com/servo/servo/) repository.
* Alternatively use the `shell.nix`
* Install the nightly compiler from February

```console
rustup install nightly-2024-02-01
rustup default nightly-2024-02-01
$ rustup install nightly-2024-02-01
$ rustup default nightly-2024-02-01
```

# Notes
* Then run in release mode

## cargo.lock
```console
$ cargo run --release
```

We need to copy the cargo.lock from the servo repository to ensure we have the correct patched versions of crates.
## Licensing

## Logging
This demo is Copyright (C) Klarälvdalens Datakonsult AB, and is available under
the terms of the [MPL-2.0](https://github.com/KDABLabs/cxx-qt-servo-webview/blob/main/LICENSES/MPL-2.0.txt) license.

```console
RUST_LOG="debug" cargo run
```
Contact KDAB at <[email protected]> to inquire about additional features or
services related to this project.

## Rust
# About KDAB

We might need
The KDAB Group is the global No.1 software consultancy for Qt, C++ and
OpenGL applications across desktop, embedded and mobile platforms.

```console
rustup components add llvm-tools rustc-dev
```
The KDAB Group provides consulting and mentoring for developing Qt applications
from scratch and in porting from all popular and legacy frameworks to Qt.
We continue to help develop parts of Qt and are one of the major contributors
to the Qt Project. We can give advanced or standard trainings anywhere
around the globe on Qt as well as C++, OpenGL, 3D and more.

Please visit <https://www.kdab.com> to meet the people who write code like this.

0 comments on commit 20ac6af

Please sign in to comment.