You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tools/code-extension.mdx
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ You can create a new LF package either manually by creating an LF file or by usi
21
21
2. Save the file in a directory called `src` to ensure that generated code is placed in a parallel `src-gen` directory. For example, if your file is called `Foo.lf`, the directory structure after building will look like this:
22
22
23
23
```
24
-
├── LF Package
24
+
├── .
25
25
│ ├── bin/
26
26
│ │ └── Foo
27
27
│ ├── src/
@@ -31,7 +31,7 @@ You can create a new LF package either manually by creating an LF file or by usi
31
31
...
32
32
```
33
33
34
-
Additionally, it's important to manually create the `Lingo.toml` fileadjacent to the `src` folder in the root directory of the package.. This file serves as a configuration for the package, allowing you to specify the package name, version, and other metadata, including any dependencies you want to install.
34
+
If you manually create the `Lingo.toml` file, place it adjacent to the `src` folder in the root directory of the package. This file serves as a configuration for the package, allowing you to specify the package name, version, and other metadata, including any dependencies you want to install.
35
35
36
36
#### Option 2: Create an LF Package Using the Lingo Package Manager
37
37
1. After installing and configuring the Lingo Package Manager, create an empty folder with the desired name for the LF package.
@@ -41,7 +41,7 @@ Additionally, it's important to manually create the `Lingo.toml` file adjacent t
41
41
This will set up a new LF package with the following structure:
42
42
43
43
```
44
-
├── LF Package
44
+
├── .
45
45
│ ├── src/
46
46
│ │ └── Main.lf
47
47
└── └── Lingo.toml # Configuration file for current package
@@ -54,7 +54,7 @@ To open an existing LF package in VS Code, select the root directory of your Lin
54
54
The correct structure of the LF package should look like this:
│ │ ├── lfc_include/ # Directory for storing reusable reactors
@@ -68,7 +68,7 @@ The correct structure of the LF package should look like this:
68
68
└── └── Lingo.toml # Configuration file for Lingo Package Manager
69
69
```
70
70
71
-
To correctly enable the [Package Explorer](#package-explorer), we recommend opening VS Code with the true root of your Lingua Franca package as your workspace. If the package structure deviates from the expected format, an error message will appear when opening the Package Explorer:
71
+
To enable the [Package Explorer](#package-explorer), the workspace of your VS Code editor must be the root of a Lingua Franca package. If the workspace is not recognized as a valid Lingua Franca package, an error message will appear when opening the Package Explorer:
@@ -90,7 +90,7 @@ Running the code can also be done from the VS Code terminal by executing the gen
90
90
The **Lingua Franca Package Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Package Explorer** displays a **Tree View** with the following structure:
91
91
92
92
```
93
-
├── LF Package
93
+
├── <Package Name>
94
94
│ ├── Installed Packages
95
95
│ ├── Local Libraries
96
96
└── └── Source Files
@@ -163,7 +163,7 @@ The **Import Selected Reactor** option is available only if an LF program is ope
163
163
The **Local Libraries** section lists LF programs created by the developer, located in the `./src/lib/` directory. These programs serve as local libraries, containing reusable reactors. The directory structure follows this format:
164
164
165
165
```
166
-
├── LF Package
166
+
├── <Package Name>
167
167
...
168
168
│ ├── Local Libraries
169
169
│ │ ├── File_1.lf
@@ -204,7 +204,7 @@ The **Import Selected Reactor** option is available only if an LF program is ope
204
204
The **Source Files** section lists all LF programs in the `./src/` directory. This section provides direct access to the main source files of the package. The hierarchy for this view is straightforward:
205
205
206
206
```
207
-
├── LF Package
207
+
├── <Package Name>
208
208
...
209
209
│ ├── Local Libraries
210
210
│ │ ├── File_1.lf
@@ -213,7 +213,7 @@ The **Source Files** section lists all LF programs in the `./src/` directory. Th
213
213
...
214
214
```
215
215
216
-
Clicking on any of the files will open the corresponding LF program in the editor, allowing developers to quickly navigate to and edit the source code of their package.
216
+
Clicking on any of the files will open the corresponding LF program in the editor, providing a way to quickly navigate and edit the source code of a package.
0 commit comments