Skip to content

Commit

Permalink
Create README.me
Browse files Browse the repository at this point in the history
Just making a super simple README to get us started.
  • Loading branch information
Eric Sorenson authored Jan 23, 2020
1 parent ced1ede commit a82de5f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# VSCode Extension for the CUE Language

## What it's for

CUE - Configure, Unify, Execute - is a language designed for designing,
generating, and validating data. Read more about it on [the official site, cuelang.org](https://cuelang.org).

## Why this extension is useful

[Visual Studio Code](https://code.visualstudio.com/) is an awesome, extensible, multi-platform editor and IDE.
Its ecosystem has a massive number of plugins for different languages, and this one implements syntax highlighting
(and potentially more functionality in the future) for the CUE language.

## How you can use it

Unfortunately, the `.cue` extension which CUE uses is squatted on in the "official" VSCode registry by the file format used to describe audio CD tracklistings.
So for the moment, manual installation is required. This is quite simple though. Once you have VSCode installed, simply clone this repo into its extension location:

```shell
cd ~/.vscode/extensions
git clone [email protected]:betawaffle/vscode-cue.git
```

Restart VSCode and you should have syntax highlighting for any `.cue` files you load.

0 comments on commit a82de5f

Please sign in to comment.