For our Rust, C++, and Node.js templates, recommend the use of a zip archive download instead of git

This removes any git history of ours from the download, and removes the need to have git installed.
This commit is contained in:
Simon Hausmann 2024-09-18 10:14:48 +02:00 committed by Simon Hausmann
parent 902cb17865
commit ddfbd1821a
4 changed files with 21 additions and 11 deletions

View file

@ -89,7 +89,7 @@ game.
## Template
You can clone the [Template Repository](https://github.com/slint-ui/slint-cpp-template) repository with
You can check out the [Slint C++ Template](https://github.com/slint-ui/slint-cpp-template) with
the code of a minimal C++ application using Slint. It provides a convenient starting point to a new program.
Of course you can also read on: We will cover some recipes to handle common

View file

@ -49,8 +49,12 @@ contains more advanced examples and alternative ways to use this crate.
To quickly get started, use the [Template Repository](https://github.com/slint-ui/slint-rust-template) with
the code of a minimal application using Slint as a starting point for your program.
1. Download and extract the [ZIP archive of the Rust Template](https://github.com/slint-ui/slint-rust-template/archive/refs/heads/main.zip).
2. Rename the extracted directory and change into it:
```bash
git clone https://github.com/slint-ui/slint-rust-template my-project
mv slint-rust-template-main my-project
cd my-project
```
## More examples

View file

@ -98,8 +98,12 @@ fn main() {
Use our [Template Repository](https://github.com/slint-ui/slint-rust-template) to create a skeleton file
hierarchy that uses this method:
1. Download and extract the [ZIP archive of the Rust Template](https://github.com/slint-ui/slint-rust-template/archive/refs/heads/main.zip).
2. Rename the extracted directory and change into it:
```bash
git clone https://github.com/slint-ui/slint-rust-template my-project
mv slint-rust-template-main my-project
cd my-project
```
## Generated components

View file

@ -17,10 +17,11 @@ Slint has application templates you can use to create a project with dependencie
Before using the template, you need a C++ compiler that supports C++ 20 and to install [CMake](https://cmake.org/download/) 3.21 or newer.
Clone or download the template repository:
1. Download and extract the [ZIP archive of the C++ Template](https://github.com/slint-ui/slint-cpp-template/archive/refs/heads/main.zip).
2. Rename the extracted directory and change into it:
```sh
git clone https://github.com/slint-ui/slint-cpp-template memory
mv slint-cpp-template-main memory
cd memory
```
@ -90,14 +91,14 @@ my_application
::::{tab-item} NodeJS
:sync: nodejs
Clone or download the template repository:
1. Download and extract the [ZIP archive of the Node.js Template](https://github.com/slint-ui/slint-nodejs-template/archive/refs/heads/main.zip).
2. Rename the extracted directory and change into it:
```sh
git clone https://github.com/slint-ui/slint-nodejs-template memory
mv slint-nodejs-template-main memory
cd memory
```
Install dependencies with npm:
3. Install dependencies with npm:
```sh
npm install
@ -134,10 +135,11 @@ Run the example with `npm start` and a window appears with the green "Hello Worl
We recommend using [rust-analyzer](https://rust-analyzer.github.io) and [our editor integrations for Slint](https://github.com/slint-ui/slint/tree/master/editors) for following this tutorial.
Clone or download the template repository:
1. Download and extract the [ZIP archive of the Rust Template](https://github.com/slint-ui/slint-rust-template/archive/refs/heads/main.zip).
2. Rename the extracted directory and change into it:
```sh
git clone https://github.com/slint-ui/slint-rust-template memory
mv slint-rust-template-main memory
cd memory
```