From 3d445d982a9f7432a054629c624e3dde41a23120 Mon Sep 17 00:00:00 2001 From: Jacob Hummer Date: Wed, 16 Aug 2023 00:09:51 -0500 Subject: [PATCH] Update README.md --- README.md | 43 +++++-------------------------------------- 1 file changed, 5 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 3ea99e0..853a320 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,6 @@ -# Dev Containers single Feature starter kit +# LLVM Dev Container Feature -🚀 Quickstart to create your own singular Dev Container Feature - -

- -

- -## Usage - - - -**Click Use this template!** That's the first step. After instantiating this template repo, there are a few things you'll need to do manually: - -1. Change the name in the `LICENSE` file to be your name or your organization's name. Right now it's `YOUR_NAME`. - -2. Change or remove the banner image in the lower part of this readme. Don't worry, a banner image isn't required. - -3. Change the example from `"ghcr.io/octocat/features/i-am-awesome:1": {}` to your own name and feature name. - -4. Change any of the other readme text to match your own new awesome feature. 🚀 - -5. Remove the top part of this `README.md` file. You don't want this template guide showing up on your own awesome feature, do you? 😉 - ---- - - -# I am awesome Dev Container Feature - -🤩 Tells you that **you are awesome** when you start your Dev Container! - -

- -

- -Uses the `postAttachCommand` to tell you that **you are awesome** whenever you start the Dev Container. ❤️ +🏭 Installs the LLVM toolchain ## Usage @@ -41,7 +8,7 @@ Uses the `postAttachCommand` to tell you that **you are awesome** whenever you s // devcontainer.json { "features": { - "ghcr.io/octocat/features/i-am-awesome:1": {} + "ghcr.io/octocat/features/llvm": {} } } ``` @@ -50,8 +17,8 @@ Uses the `postAttachCommand` to tell you that **you are awesome** whenever you s ### Options -There are currently no options. If you'd like to add a `version` option, open an -Issue or a PR! ❤️ +- **`version`:** Pin to a specific LLVM toolchain version. Can also be `latest` + to use the most recent version. The default is `latest`. [this vs code blog post]: https://code.visualstudio.com/blogs/2022/09/15/dev-container-features