From bbe178aadf25a81f803ca7134cf258ce736f9588 Mon Sep 17 00:00:00 2001 From: Olivier Goffart Date: Tue, 28 Sep 2021 08:24:44 +0200 Subject: [PATCH] Add links to the template repositories --- api/sixtyfps-cpp/README.md | 2 ++ api/sixtyfps-cpp/docs/getting_started.md | 5 +++++ api/sixtyfps-rs/README.md | 8 ++++++++ api/sixtyfps-rs/lib.rs | 8 ++++++++ 4 files changed, 23 insertions(+) diff --git a/api/sixtyfps-cpp/README.md b/api/sixtyfps-cpp/README.md index 9b326e040..5e2dc0183 100644 --- a/api/sixtyfps-cpp/README.md +++ b/api/sixtyfps-cpp/README.md @@ -235,3 +235,5 @@ That's it. For more details, check the [Online documentation](https://sixtyfps.io/docs/cpp) and the full [Walk-through tutorial](https://sixtyfps.io/docs/tutorial/cpp). +We also have a [Getting Started Template](https://github.com/sixtyfpsui/sixtyfps-cpp-template) repository with +the code of a minimal C++ application using SixtyFPS that can be used as a starting point to your program. diff --git a/api/sixtyfps-cpp/docs/getting_started.md b/api/sixtyfps-cpp/docs/getting_started.md index ee8fe2dff..06808a83e 100644 --- a/api/sixtyfps-cpp/docs/getting_started.md +++ b/api/sixtyfps-cpp/docs/getting_started.md @@ -74,3 +74,8 @@ the ui, read or write properties or set callbacks. You can learn more about how For an in-depth walk-through, you may be interested in reading our walk-through SixtyFPS Memory Game Tutorial Tutorial. It will guide you through the `.60` mark-up language and the C++ API by building a little memory game. + +## Template + +You can clone the [Template Repository](https://github.com/sixtyfpsui/sixtyfps-cpp-template) repository with +the code of a minimal C++ application using SixtyFPS that can be used as a starting point to your program. diff --git a/api/sixtyfps-rs/README.md b/api/sixtyfps-rs/README.md index f566feae9..b54a298ec 100644 --- a/api/sixtyfps-rs/README.md +++ b/api/sixtyfps-rs/README.md @@ -44,6 +44,14 @@ fn main() { The [`sixtyfps` crate documentation](https://sixtyfps.io/docs/rust/sixtyfps/) contains more advanced examples and alternative ways to use this crate. +To quickly get started, you can use the [Template Repository](https://github.com/sixtyfpsui/sixtyfps-rust-template) with +the code of a minimal application using SixtyFPS that can be used as a starting point to your program. + +```bash +cargo install cargo-generate +cargo generate --git https://github.com/sixtyfpsui/sixtyfps-rust-template +``` + ## More examples You can quickly try out the [examples](/examples) by cloning this repo and running them with `cargo run` diff --git a/api/sixtyfps-rs/lib.rs b/api/sixtyfps-rs/lib.rs index d20f2d24d..2362a4013 100644 --- a/api/sixtyfps-rs/lib.rs +++ b/api/sixtyfps-rs/lib.rs @@ -91,6 +91,14 @@ fn main() { } ``` +To quickly get started with this pattern, we have a [Template Repository](https://github.com/sixtyfpsui/sixtyfps-rust-template) that +can be used with cargo-generate. + +```bash +cargo install cargo-generate +cargo generate --git https://github.com/sixtyfpsui/sixtyfps-rust-template +``` + ## Generated components As of now, only the last component of a .60 source is generated. It is planned to generate all exported components.