Skip to content

Commit 8106587

Browse files
committed
Update documentation to reflect latest changes
1 parent b45b77b commit 8106587

File tree

7 files changed

+31
-22
lines changed

7 files changed

+31
-22
lines changed
-19.4 KB
Binary file not shown.

docs/assets/images/vs_code/error_message.svg

Lines changed: 3 additions & 0 deletions
Loading
-30.7 KB
Binary file not shown.

docs/assets/images/vs_code/lingo_packages.svg

Lines changed: 3 additions & 0 deletions
Loading
-28.4 KB
Binary file not shown.

docs/assets/images/vs_code/local_libraries.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/tools/code-extension.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: VS Code Extension
33
description: Visual Studio Code Extension for Lingua Franca.
44
---
55

6-
The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-directed editing capability, compilation, diagram synthesis and a project explorer for Lingua Franca programs.
6+
The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-directed editing capability, compilation, diagram synthesis and a packages explorer for Lingua Franca programs.
77

88
## Usage
99

@@ -23,9 +23,9 @@ Overall, we encourage you to open your project in VS Code using the following st
2323
```shell
2424
├── root
2525
│ ├── bin/
26-
│ ├── build/ # directory containing lingo packages
26+
│ ├── build/ # directory containing packages installed by Lingo Package Manager
2727
│ │ ├── lfc_include/ # Directory for storing reusable reactors
28-
│ │ │ ├── lingo_library/
28+
│ │ │ ├── installed_library/
2929
│ ├── include/
3030
│ ├── src/
3131
│ │ ├── lib/ # Directory for storing reusable reactors
@@ -47,41 +47,41 @@ To compile the `.lf` source, open the command palette (<kbd>Ctrl</kbd> + <kbd>Sh
4747
You can also build and immediately afterwards run your code by opening the command palette (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) and then entering `Lingua Franca: Build and Run`.
4848
Running the code can also be done from the VS Code terminal by executing the generated file in `./bin`.
4949

50-
### Project Explorer
50+
### Packages Explorer
5151

52-
The **Lingua Franca Project Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Project Explorer** displays a **Tree View** with the following structure:
52+
The **Lingua Franca Packages Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Packages Explorer** displays a **Tree View** with the following structure:
5353

5454
```shell
5555
├── LF Project
56-
│ ├── Lingo Packages
56+
│ ├── Installed Packages
5757
│ ├── Local Libraries
5858
└── └── Source Files
5959
```
6060

61-
- **Lingo Packages**: Lists libraries installed via the Lingo Package Manager, located in the `build/lfc_include` directory (if any).
61+
- [**Installed Packages**](#installed-packages): Lists libraries installed via the Lingo Package Manager, located in the `build/lfc_include` directory (if any).
6262

63-
- **Local Libraries**: Displays locally defined libraries (e.g., reusable reactors), located in the `src/lib` directory.
63+
- [**Local Libraries**](#local-libraries): Displays locally defined libraries (e.g., reusable reactors), located in the `src/lib` directory.
6464

65-
- **Source Files**: Contains the LF source files created by the developer, located in the `src` directory.
65+
- [**Source Files**](#source-files): Contains the LF source files created by the developer, located in the `src` directory.
6666

67-
The **Source Files** section is always present as it reflects the main LF files in the project. However, the **Lingo Packages** and **Local Libraries** sections appear only if the respective directories and files exist in the workspace.
67+
The **Source Files** section is always present as it reflects the main LF files in the project. However, the **Installed Packages** and **Local Libraries** sections appear only if the respective directories and files exist in the workspace.
6868

6969
Hovering over the **LF Project** item reveals a terminal icon. Clicking this icon opens a terminal window at the project's root directory, allowing you to execute commands directly within that directory.
7070

71-
#### Lingo Packages
71+
#### Installed Packages
7272

73-
The **Lingo Packages** section lists libraries installed using the [Lingo Package Manager](https://github.com/lf-lang/lingo). Developers can use the Lingo Package Manager to retrieve and install LF programs from repositories such as the [Lingua Franca Community Organization](https://github.com/LF-Community).
73+
The **Installed Packages** section lists libraries installed using the [Lingo Package Manager](https://github.com/lf-lang/lingo). Developers can use the Lingo Package Manager to retrieve and install LF programs from repositories such as the [Lingua Franca Community Organization](https://github.com/LF-Community).
7474

7575
To install libraries:
7676
1. Configure the `Lingo.toml` file with the desired libraries.
7777
2. Run `lingo build` to download the specified dependencies.
7878

79-
Once the libraries are installed, they will appear in the `{project_name}/build/lfc_include/` directory. The **Lingo Packages** section will then be structured as follows:
79+
Once the libraries are installed, they will appear in the `{project_name}/build/lfc_include/` directory. The **Installed Packages** section will then be structured as follows:
8080

8181
```shell
8282
├── LF Project
83-
│ ├── Lingo Packages
84-
│ │ ├── lingo_library/
83+
│ ├── Installed Packages
84+
│ │ ├── installed_library/
8585
│ │ │ ├── File_1.lf
8686
│ │ │ │ ├── Rusable_Reactor_1.lf
8787
│ │ │ │ ├── Rusable_Reactor_2.lf
@@ -93,19 +93,19 @@ Once the libraries are installed, they will appear in the `{project_name}/build/
9393

9494
In this structure:
9595
- **LF Project**: Represents the root folder of the main project.
96-
- **lingo_library**: Represents each library listed in `Lingo.toml`, which contains one or more LF programs featuring reusable reactors.
96+
- **installed_library**: Represents each library listed in `Lingo.toml`, which contains one or more LF programs featuring reusable reactors.
9797

98-
The image below shows a visual representation of the **Lingo Packages** section. The **project** icon indicates the LF Project folder (e.g., `AudioClassification`), while the **root-folder** icon represents the downloaded libraries (e.g., the `edgeai` library in the example). The **code file** icon denotes an LF program within a library, and the **bracket** icon represents individual reactors inside the LF program.
98+
The image below shows a visual representation of the **Installed Packages** section. The **project** icon indicates the LF Project folder (e.g., `AudioClassification`), while the **root-folder** icon represents the downloaded libraries (e.g., the `edgeai` library in the example). The **code file** icon denotes an LF program within a library, and the **bracket** icon represents individual reactors inside the LF program.
9999

100-
![Lingo Packages section](../assets/images/vs_code/lingo_packages.png)
100+
![Installed Packages section](../assets/images/vs_code/lingo_packages.svg)
101101

102102
The hierarchy categorizes tree items into the following types:
103103

104104
1. **`library-root`**: Refers to the root folder of each downloaded library.
105105
2. **`file`**: Represents an LF program within the library.
106106
3. **`reactor`**: Refers to individual reactors within the LF program.
107107

108-
When focusing on the **Lingo Packages** section, an `edit` command becomes available. Clicking it opens the `Lingo.toml` file in the editor for configuration changes. The following actions are available for items in the **Lingo Packages** section:
108+
When focusing on the **Installed Packages** section, an `edit` command becomes available. Clicking it opens the `Lingo.toml` file in the editor for configuration changes. The following actions are available for items in the **Installed Packages** section:
109109

110110
- For **file** items (from right to left):
111111
- **Open in Split View**: Opens the file in a split editor view.
@@ -137,14 +137,14 @@ The **Local Libraries** section lists LF programs created by the developer, loca
137137

138138
The image below illustrates the **Local Libraries** section. In this depiction, the **"project"** icon represents the LF project folder, while the **"code file"** icon represents the LF program, and the **"bracket"** icon denotes individual reactors within the LF program.
139139

140-
![Local Libraries section](../assets/images/vs_code/local_libraries.png)
140+
![Local Libraries section](../assets/images/vs_code/local_libraries.svg)
141141

142142
The hierarchy categorizes tree items into two types:
143143

144144
1. **`file`**: Represents the LF program.
145145
2. **`reactor`**: Represents a reactor within the LF program.
146146

147-
Actions for **Local Libraries** are similar to those in the [**Lingo Packages**](#lingo-packages) section:
147+
Actions for **Local Libraries** are similar to those in the [**Installed Packages**](#installed-packages) section:
148148

149149
- For **file** items (from right to left):
150150
- **Open in Split View**: Opens the file in a split editor view.
@@ -177,7 +177,7 @@ Clicking on any of the files will open the corresponding LF program in the edito
177177

178178
If the project structure deviates from the expected format, an error message will appear:
179179

180-
![Project structure error](../assets/images/vs_code/error_message.png)
180+
![Project structure error](../assets/images/vs_code/error_message.svg)
181181

182182
To avoid errors, follow the [project structure guidelines](#creating-a-new-file).
183183

0 commit comments

Comments
 (0)