Skip to content

Commit

Permalink
Merge pull request torizon#287 from torizon/dev
Browse files Browse the repository at this point in the history
Release v2.7.0
  • Loading branch information
microhobby authored Dec 10, 2024
2 parents 05edf88 + 070a7bf commit 2fca557
Show file tree
Hide file tree
Showing 99 changed files with 789 additions and 2,109 deletions.
24 changes: 19 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ The purpose of `Dockerfile.sdk` is to create an image with the cross toolchain S

> ⚠️ The `Dockerfile.sdk` file is needed only if the application framework or runtime only runs machine code.
#### Scripts
### Scripts

For some templates, complex and very specific tasks are required. For these cases add a new script in the [scripts](./scripts) folder.

The idea is that the project created from the template should be independent of this repository and the creation mechanisms. So, when creating a new template that needs a script, copy the script to the `.conf` folder of the created project.

> ⚠️ Check the [createFromTemplate.ps1](./scripts/createFromTemplate.ps1) script for reference.
#### Substitution tags
### Substitution tags

Substitution tags can be used inside files and as folders names to rename stuff needed by the project template. There are two substitution tags used by Torizon IDE Extension:

Expand All @@ -78,7 +78,7 @@ Substitution tags can be used inside files and as folders names to rename stuff

> ⚠️ Check the [createFromTemplate.ps1](./scripts/createFromTemplate.ps1) script for reference.
#### Dot VS Code Folder
### Dot VS Code Folder

In the `.vscode` folder the following files are expected:

Expand Down Expand Up @@ -108,7 +108,7 @@ In the `.vscode` folder the following files are expected:

> ℹ️ All these are VS Code related files, check the Microsoft official documentation to know more: [Documentation for Visual Studio Code](https://code.visualstudio.com/docs)

#### Dot Conf Folder
### Dot Conf Folder

In the `.conf` folder the following files are expected:

Expand All @@ -129,7 +129,7 @@ In the `.conf` folder the following files are expected:

> ⚠️ The "private" and public keys used on Torizon IDE Extension projects are only for debug purposes!

#### Dot Doc Folder
### Dot Doc Folder

In the `.doc` folder is present the documentation specific of each template.

Expand All @@ -139,6 +139,20 @@ This documentation should give some explanation of how the code is being built a

The media (images, videos, GIFs and so on) of the template documentation should be stored on the [toradex/vscode-torizon-templates-documentation](https://github.com/toradex/vscode-torizon-templates-documentation/]) GitHub repository

### Root Folder

In the `.` (root) folder, there are two files that must be edited when a template is created:

- [README.md](./README.md): you must add the template to the list of Partner or Community templates.
- [templates.json](./templates.json): you must add a template entry to this file. When a new project is created, the IDE uses this file to list the template for the users.

## Testing a New Template

To test a new template, you must instruct the Torizon IDE Extension to use your repository. Export the following environment variables and open VS Code from a terminal:

- `TEST_TEMPLATES_GIT_REPO`: path to your local repository or Git URL to your remote repository.
- `TEST_TEMPLATES_GIT_REPO_BRANCH`: Git branch where the template to be tested is being developed. The tip of the branch will be fetched.
- `TEST_TEMPLATES_GIT_TAG`: this tag is reserved for the IDE usage. For testing, set the value to be the same as `TEST_TEMPLATES_GIT_REPO_BRANCH`.

## Creating a Pull Request

Expand Down
8 changes: 5 additions & 3 deletions DEPRECATED.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Deprecated templates

| TEMPLATE | DESCRIPTION | RUNTIME | LANGUAGE | HW ARCH | FOLDER | CONTRIBUTOR |
| -------- | ----------- | ------- | -------- | ------- | ------ | ----------- |
| ![](https://raw.githubusercontent.com/toradex/vscode-torizon-templates-documentation/refs/heads/main/thumbnails/unogtk.png?raw=true) | .NET 6 C# Uno Platform Skia.GTK | .NET 6.0 | C# | ![](assets/img/arm32.png?raw=true&id=2) ![](assets/img/arm64.png?raw=true&id=2)   | [dotnetUno](./dotnetUno) | ![](https://avatars.githubusercontent.com/u/2633321?v=4&s=64&s=64) [@microhobby](https://www.github.com/microhobby) |
| ![](https://raw.githubusercontent.com/toradex/vscode-torizon-templates-documentation/refs/heads/main/thumbnails/unofbdrm.png?raw=true) | .NET 6 C# Uno Platform Frame Buffer | .NET 6.0 | C# | ![](assets/img/arm32.png?raw=true&id=2) ![](assets/img/arm64.png?raw=true&id=2) | [dotnetUnoFrameBuffer](./dotnetUnoFrameBuffer) | ![](https://avatars.githubusercontent.com/u/2633321?v=4&s=64) [@microhobby](https://www.github.com/microhobby) |

Due to the eminent EOL of .NET 6, .NET 6 Uno and .NET 6 Uno FrameBuffer templates are deprecated, being replaced by the [.NET 8 Uno 5](./dotnetUno5) and [.NET 8 Uno 5 FrameBuffer](./dotnetUno5FrameBuffer) templates.

Due to the quite big difference between .NET 6 Uno 4 and .NET 8 Uno 5, it is not possible to update the project via `try-update-template` task. To update it, create a new .NET 8 Uno 5 clean project and update the source files accordingly.

| ![](assets/img/unogtk.png?raw=true) | .NET 6 C# Uno Platform Skia.GTK | .NET 6.0 | C# | ![](assets/img/arm32.png?raw=true&id=2) ![](assets/img/arm64.png?raw=true&id=2)  ![](assets/img/x8664.png?raw=true&id=2) | [dotnetUno](./dotnetUno) |
| ![](assets/img/unofbdrm.png?raw=true) | .NET 6 C# Uno Platform Frame Buffer | .NET 6.0 | C# | ![](assets/img/arm32.png?raw=true&id=2) ![](assets/img/arm64.png?raw=true&id=2) | [dotnetUnoFrameBuffer](./dotnetUnoFrameBuffer) | ![](https://avatars.githubusercontent.com/u/2633321?v=4) [@microhobby](https://www.github.com/microhobby) |
Loading

0 comments on commit 2fca557

Please sign in to comment.