Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jcbhmr authored Aug 16, 2023
1 parent f6cd932 commit 3d445d9
Showing 1 changed file with 5 additions and 38 deletions.
43 changes: 5 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,14 @@
# Dev Containers single Feature starter kit
# LLVM Dev Container Feature

🚀 Quickstart to create your own singular Dev Container Feature

<p align=center>
<img src=>
</p>

## Usage

<img align=right src=https://i.imgur.com/woHa37r.png>

**Click <kbd>Use this template</kbd>!** 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? 😉

---
<!-- REMOVE THIS LINE AND EVERYTHING ABOVE -->

# I am awesome Dev Container Feature

🤩 Tells you that **you are awesome** when you start your Dev Container!

<p align=center>
<img width=400 src=https://i.imgur.com/7On7iXn.png>
</p>

Uses the `postAttachCommand` to tell you that **you are awesome** whenever you start the Dev Container. ❤️
🏭 Installs the LLVM toolchain

## Usage

```jsonc
// devcontainer.json
{
"features": {
"ghcr.io/octocat/features/i-am-awesome:1": {}
"ghcr.io/octocat/features/llvm": {}
}
}
```
Expand All @@ -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`.

<!-- prettier-ignore -->
[this vs code blog post]: https://code.visualstudio.com/blogs/2022/09/15/dev-container-features

0 comments on commit 3d445d9

Please sign in to comment.