From 34a7aa4be610d425bf30d5dd783abc6775ecf1e1 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Thu, 31 Aug 2023 14:17:10 -0500 Subject: [PATCH 1/6] add more content --- README.md | 64 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 52 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 75cdd73..ffa2e3f 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,64 @@ -# Tiny Go (no sudo) (tinygo) +# TinyGo -A feature to install tiny go (no sudo) +🤏 Installs tinygo from [tinygo-org/tinygo] -## Example Usage +

+ +

+ +> TinyGo is a new compiler for an existing programming language, the Go +> programming language. TinyGo focuses on compiling code written in Go, but for +> smaller kinds of systems: +> +> - The Go compiler and tools (from golang.org) are the reference implementation +> of the Go programming language. They are primarily intended for server side +> programming but also used for command line tools and other purposes. +> - The TinyGo project implements the exact same programming language. However, +> TinyGo uses a different compiler and tools to make it suited for embedded +> systems and WebAssembly. It does this primarily by creating much smaller +> binaries and targeting a much wider variety of systems. + +— [Overview | TinyGo](https://tinygo.org/getting-started/overview/) + +This Dev Container Feature will install TinyGo using the official `.deb` from +the [TinyGo Releases page]. You are then able to use `tinygo` as normal! This +Feature will also auto-install the [TinyGo VS Code extension] and the official +[Golang VS Code extension]. Happy Gophering! 🐿 + +## Usage + +![Codespaces](https://img.shields.io/static/v1?style=for-the-badge&message=Codespaces&color=181717&logo=GitHub&logoColor=FFFFFF&label=) +![Devcontainers](https://img.shields.io/static/v1?style=for-the-badge&message=Devcontainers&color=2496ED&logo=Docker&logoColor=FFFFFF&label=) + +To use this feature, all you need to do is add it to your `devcontainer.json` +like this: ```json +// devcontainer.json "features": { - "ghcr.io/devcontainers-community/features/tinygo": {} + "ghcr.io/devcontainers-community/features/tinygo": {} } ``` -## Options +❓ Don't know what this ☝ means? Check out [this VS Code blog post]. -| Options Id | Description | Type | Default Value | -|-----|-----|-----|-----| -| version | Specify a version of Tiny Go | string | 0.27,0 | +### Options -## Customizations +If you want to specify a specific version of TinyGo, you can do so like this +with the `version` option: -### VS Code Extensions +```jsonc +"features": { + "ghcr.io/devcontainers-community/features/tinygo": { + "version": "" + } +} +``` -- `tinygo.vscode-tinygo` -- `golang.go` + +[this vs code blog post]: https://code.visualstudio.com/blogs/2022/09/15/dev-container-features +[tinygo-org/tinygo]: https://github.com/tinygo-org/tinygo +[TinyGo Releases page]: https://github.com/tinygo-org/tinygo/releases +[TinyGo VS Code extension]: https://marketplace.visualstudio.com/items?itemName=tinygo.vscode-tinygo +[Golang VS Code extension]: https://marketplace.visualstudio.com/items?itemName=golang.go + From 40652fb6648f1a73d18aada5d26932f6a6748045 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Thu, 31 Aug 2023 14:17:17 -0500 Subject: [PATCH 2/6] update metadata to reflect readme --- devcontainer-feature.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/devcontainer-feature.json b/devcontainer-feature.json index a2b049f..2e38c8c 100644 --- a/devcontainer-feature.json +++ b/devcontainer-feature.json @@ -1,8 +1,8 @@ { - "name": "Tiny Go (no sudo)", + "name": "TinyGo", "id": "tinygo", - "version": "1.0.0", - "description": "A feature to install tiny go (no sudo)", + "version": "1.0.1", + "description": "🤏 Installs tinygo from tinygo-org/tinygo", "options": { "version": { "type": "string", From b53445b63ac2de53c24ba8499d20347736dfa6d6 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Thu, 31 Aug 2023 14:19:01 -0500 Subject: [PATCH 3/6] json -> jsonc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ffa2e3f..49dad4f 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Feature will also auto-install the [TinyGo VS Code extension] and the official To use this feature, all you need to do is add it to your `devcontainer.json` like this: -```json +```jsonc // devcontainer.json "features": { "ghcr.io/devcontainers-community/features/tinygo": {} From af535f5bede25911f872e99a0ec3a3b455f6ef0a Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Thu, 31 Aug 2023 14:24:56 -0500 Subject: [PATCH 4/6] actual version number --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 49dad4f..1131fc0 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ with the `version` option: ```jsonc "features": { "ghcr.io/devcontainers-community/features/tinygo": { - "version": "" + "version": "0.29.0" } } ``` From e35f2a548c22fb21eb29326b8d144ffdd0bbc707 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Thu, 31 Aug 2023 14:27:25 -0500 Subject: [PATCH 5/6] add "back to feature collection" and clarify title "... dev container feature" --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1131fc0..6fe127e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# TinyGo +[⬅️ Back to feature collection](https://github.com/devcontainers-community/features/) + +# TinyGo Dev Container Feature 🤏 Installs tinygo from [tinygo-org/tinygo] From 419f76941f232fd72f5bbdb336e0cd8643814e37 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Tue, 5 Sep 2023 11:12:38 -0500 Subject: [PATCH 6/6] =?UTF-8?q?update=20emoji=20to=20=F0=9F=90=BF=EF=B8=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6fe127e..e56cfef 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ This Dev Container Feature will install TinyGo using the official `.deb` from the [TinyGo Releases page]. You are then able to use `tinygo` as normal! This Feature will also auto-install the [TinyGo VS Code extension] and the official -[Golang VS Code extension]. Happy Gophering! 🐿 +[Golang VS Code extension]. Happy Gophering! 🐿️ ## Usage