Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #40

Merged
merged 1 commit into from
Apr 11, 2022
Merged

Update README.md #40

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,18 @@ This extension adds language support for [Lingua Franca](https://www.lf-lang.org
* target syntax highlighting
* code validation upon edit
* target code validation upon build (error highlighting currently for C++ only)
* user-triggered build (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>, then `Build Lingua Franca`)
* user-triggered build (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>, then `Lingua Franca: Build`)

## Quick Start
1. Install this plugin from the [VSCode
Marketplace](https://marketplace.visualstudio.com/items?itemName=lf-lang.vscode-lingua-franca)/[Open VSX Registry](https://open-vsx.org/extension/lf-lang/vscode-lingua-franca)
(in the command palette <kbd>Ctrl</kbd> + <kbd>P</kbd>, enter `ext install lf-lang.vscode-lingua-franca`)
2. (Skip this step if you already have Lingua Franca projects that you'd like
to work on.) Create a new Lingua Franca project by creating a `<My Project
Name>/src` folder and putting a file in it that has the `.lf` extension.
3. Open a Lingua Franca project (`File > Add Folder to Workspace...`). Open the
folder for the whole project (i.e., the folder containing the `src` folder).
Name>/src` folder and put a file in it that has the `.lf` extension.
3. Open a Lingua Franca project (`File > Add Folder to Workspace...`). The Explorer (upper left in sidebar) should now show your project files. Open the `.lf` file you created.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step 3 and 2 look like they should be a single step. Step 4 isn't really necessary; perhaps that, too can be factored into step 2...

4. Show the diagram for this file by clicking on the diagrams icon at the upper right: ![image](https://user-images.githubusercontent.com/33707478/130875545-ad78a9b7-a07b-4eb9-be59-f6c758cc816b.png))
5. Compile the `.lf` file using (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>, then `Lingua Franca: Build`).

## Contributing
We very much appreciate contributions in the form of
Expand Down