Skip to content

Commit 3d445d9

Browse files
authored
Update README.md
1 parent f6cd932 commit 3d445d9

File tree

1 file changed

+5
-38
lines changed

1 file changed

+5
-38
lines changed

README.md

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,14 @@
1-
# Dev Containers single Feature starter kit
1+
# LLVM Dev Container Feature
22

3-
🚀 Quickstart to create your own singular Dev Container Feature
4-
5-
<p align=center>
6-
<img src=>
7-
</p>
8-
9-
## Usage
10-
11-
<img align=right src=https://i.imgur.com/woHa37r.png>
12-
13-
**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:
14-
15-
1. Change the name in the `LICENSE` file to be your name or your organization's name. Right now it's `YOUR_NAME`.
16-
17-
2. Change or remove the banner image in the lower part of this readme. Don't worry, a banner image isn't required.
18-
19-
3. Change the example from `"ghcr.io/octocat/features/i-am-awesome:1": {}` to your own name and feature name.
20-
21-
4. Change any of the other readme text to match your own new awesome feature. 🚀
22-
23-
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? 😉
24-
25-
---
26-
<!-- REMOVE THIS LINE AND EVERYTHING ABOVE -->
27-
28-
# I am awesome Dev Container Feature
29-
30-
🤩 Tells you that **you are awesome** when you start your Dev Container!
31-
32-
<p align=center>
33-
<img width=400 src=https://i.imgur.com/7On7iXn.png>
34-
</p>
35-
36-
Uses the `postAttachCommand` to tell you that **you are awesome** whenever you start the Dev Container. ❤️
3+
🏭 Installs the LLVM toolchain
374

385
## Usage
396

407
```jsonc
418
// devcontainer.json
429
{
4310
"features": {
44-
"ghcr.io/octocat/features/i-am-awesome:1": {}
11+
"ghcr.io/octocat/features/llvm": {}
4512
}
4613
}
4714
```
@@ -50,8 +17,8 @@ Uses the `postAttachCommand` to tell you that **you are awesome** whenever you s
5017

5118
### Options
5219

53-
There are currently no options. If you'd like to add a `version` option, open an
54-
Issue or a PR! ❤️
20+
- **`version`:** Pin to a specific LLVM toolchain version. Can also be `latest`
21+
to use the most recent version. The default is `latest`.
5522

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

0 commit comments

Comments
 (0)