Add instructions how to build & run the examples

This commit is contained in:
Simon Hausmann 2020-09-04 14:54:31 +02:00 committed by GitHub
parent 220dc2ee47
commit 75baf09eca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,3 +11,40 @@ Demo | `.60` Design | Rust Source | C++ Source | Description
--- | --- | --- | --- | --- --- | --- | --- | --- | ---
`printerdemo`| [`ui.60`](./printerdemo/ui/printerdemo.60) | [`main.rs`](./printerdemo/rust/main.rs) | [`main.cpp`](./printerdemo/cpp/main.cpp) | A fictional user interface for the touch screen of a printer `printerdemo`| [`ui.60`](./printerdemo/ui/printerdemo.60) | [`main.rs`](./printerdemo/rust/main.rs) | [`main.cpp`](./printerdemo/cpp/main.cpp) | A fictional user interface for the touch screen of a printer
`gallery` |[`gallery.60`](./gallery/gallery.60) | [`main.rs`](./gallery/main.rs) | [`main.cpp`](./gallery/main.cpp) | A gallery of different widgets `gallery` |[`gallery.60`](./gallery/gallery.60) | [`main.rs`](./gallery/main.rs) | [`main.cpp`](./gallery/main.cpp) | A gallery of different widgets
## Running the Rust Examples
You can run the examples either by going into the rust sub-folder and use `cargo run`, for example:
```sh
cd examples/printerdemo/rust
cargo run
```
or you can run them from anywhere in the Cargo workspace by name:
```sh
cargo run --bin printerdemo
```
## Running the C++ Examples
The C++ API comes with a CMake integration, which needs to be built first:
```sh
cargo xtask cmake
```
This creates CMake configuration files in the `target/debug` folder
(or `target/release` if you run `cargo xtask cmake --release`).
Then, from another directory, you can run cmake in the `cpp` folder of an example:
```
cd examples/printerdemo/cpp
mkdir build
cd build
cmake -DCMAKE_PREFIX_PATH=../../../../target/debug/ ..
cmake --build .
./printerdemo
```