Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
b45b77b
Updated VSCode extention docs
vinzbarbuto Oct 15, 2024
8106587
Update documentation to reflect latest changes
vinzbarbuto Oct 16, 2024
1be6372
Remove unnecessary ‘shell’ usage
vinzbarbuto Oct 17, 2024
b3c04e0
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
d212ef3
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
e057239
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
ff2b7c8
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 21, 2024
7426658
Update documentation; PNGs instead of SVGs
vinzbarbuto Oct 21, 2024
203e8b3
Update documentation; PNGs instead of SVGs
vinzbarbuto Oct 21, 2024
cda2817
Merge branch 'main' into main
vinzbarbuto Oct 21, 2024
3c69580
Added 'Create New Project' section; uniformed the use of 'package' in…
vinzbarbuto Oct 22, 2024
664bef0
Added 'Create New Project' section; uniformed the use of 'package' in…
vinzbarbuto Oct 22, 2024
7036389
Improved documentation
vinzbarbuto Oct 23, 2024
f6f1662
Improved paths in the documentation
vinzbarbuto Oct 23, 2024
5b63b67
Apply suggestions from code review
vinzbarbuto Oct 28, 2024
ed2eb08
Improved documentation; Added Glossary page
vinzbarbuto Oct 28, 2024
6fa21f1
Apply suggestions from code review
vinzbarbuto Oct 28, 2024
942770b
Update docs/tools/code-extension.mdx
vinzbarbuto Oct 28, 2024
0b89329
Improved documentation; Moved Project Structure to Glossary page
vinzbarbuto Oct 29, 2024
f42f9fc
Improved documentation
vinzbarbuto Oct 29, 2024
e544f53
Update docs/glossary/glossary.mdx
vinzbarbuto Oct 29, 2024
d4ccc94
Update code-extension.mdx
lhstrh Oct 29, 2024
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
42 changes: 37 additions & 5 deletions docs/glossary/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,49 @@ Glossary of terms used in the Lingua Franca (LF) documentation.
### LF File
A source file with the `.lf` extension, representing a Lingua Franca (LF) program.

### Library File
An LF file containing one or more reactors intended for reuse, designed to be imported into other LF files.

### Package
A collection of LF source files and directories, along with a `Lingo.toml` manifest file that defines the package configuration. Every package must include an `src/` directory containing the LF source files.

### Package Manager
A software tool that automates the installation, configuration, and management of packages. In the LF ecosystem, the `lingo` package manager is used to manage LF packages and dependencies.

### Package Root
The **package root** is the top-level directory of a package where both the `Lingo.toml` file and the `src/` directory reside.

### Project
Another term for a [package](#package) that is under development. Each [LF file](#lf-file) is assumed to reside in a package, meaning it is located somewhere in the file system in a directory called `src`, in some directory that serves as the (package root)[#package-root].

### Library File
An LF file containing one or more reactors intended for reuse, designed to be imported into other LF files.

### Package Manager
A software tool that automates the installation, configuration, and management of packages. In the LF ecosystem, the `lingo` package manager is used to manage LF packages and dependencies.
### Project Structure
The structure of an LF project should follow the directory layout below:

```
├── .
│ ├── bin/ # Directory for storing generated code
│ ├── build/ # Directory containing packages installed by the Lingo Package Manager
│ │ ├── lfc_include/ # Directory for storing reusable reactors
│ │ └── <Installed Package>/ # Directory containing the installed package
│ ├── include/ # Directory for storing header files
│ ├── src/ # Directory containing LF source files
│ │ ├── lib/ # Directory for storing reusable reactors
│ │ │ ├── Input.lf # Ex: reactor capturing external inputs (e.g., Microphone, Camera)
│ │ │ └── ComputerVision.lf # Ex: reactor performing computer vision tasks (e.g., object detection, face recognition)
│ │ └── Main.lf # Ex: main source file
└── └── Lingo.toml # Configuration file for Lingo Package Manager
```

- **Mandatory Directories and Files:**
- `src/`: This folder must contain at least one `.lf` source file.
- `Lingo.toml`: This is the required configuration file.

- **Automatically Generated Directories:**
- `bin/`: This directory is created during the build process of source files. It is used to store generated code.
- `build/`: This folder is automatically generated when installing packages managed by the Lingo Package Manager.
- `include/`: This directory is autogenerated for header files.

- **User-Created Directory:**
- `src/lib/`: This folder is for library files and should be created by the user as necessary.

This directory structure is essential for enabling the Package Explorer feature in the [VS Code Extension](tools/code-extension.mdx#package-explorer), streamlining project management and development processes.
45 changes: 13 additions & 32 deletions docs/tools/code-extension.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-dir

You can create a new LF [project](../glossary/glossary.mdx#project) either manually by creating an LF file or by using the [Lingo Package Manager](https://github.com/lf-lang/lingo).

#### Option 1: Create an Project Using the Lingo Package Manager
#### Option 1: Create a Project Using the Lingo Package Manager
1. After [installing the Lingo Package Manager](https://www.lf-lang.org/docs/installation#lingo), create an empty directory to serve as the root of your new package.
2. Open the folder in VS Code.
3. Open the terminal in this folder and run the <kbd>lingo init</kbd> command.
Expand All @@ -30,7 +30,7 @@ This will set up a new LF package with the following structure:
└── └── Lingo.toml # Configuration file for current package
```

#### Option 2: Create a new [LF File](../glossary/glossary.mdx#lf-file)
#### Option 2: Create a New [LF File](../glossary/glossary.mdx#lf-file)
1. Go to <kbd>File > New File...</kbd> and select `New Lingua Franca File`.
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:

Expand All @@ -47,28 +47,9 @@ This will set up a new LF package with the following structure:

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.

### Opening an Existing LF project
### Opening an Existing LF Project

To open an existing LF project in VS Code, select the [package root](../glossary/glossary.mdx#package-root) as your workspace.

The correct structure of the LF package should look like this:

```
├── .
│ ├── bin/
│ ├── build/ # directory containing packages installed by Lingo Package Manager
│ │ ├── lfc_include/ # Directory for storing reusable reactors
│ │ └── └── installed_package/
│ ├── include/
│ ├── src/
│ │ ├── lib/ # Directory for storing reusable reactors
│ │ │ ├── Input.lf # Ex: reactor capturing external inputs (e.g., Microphone, Camera)
│ │ │ └── ComputerVision.lf # Ex: reactor performing computer vision tasks (e.g., object detection, face recognition)
│ │ └── Main.lf # Ex: main source file
└── └── Lingo.toml # Configuration file for Lingo Package Manager
```

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:
To open an existing LF project in VS Code, select the [package root](../glossary/glossary.mdx#package-root) as your workspace. Ensure that the selected project adheres to the correct [project structure](../glossary/glossary.mdx#project-structure) to enable the [Package Explorer](#package-explorer). If the workspace is not recognized as a valid Lingua Franca package, an error message will appear when you attempt to open the Package Explorer:

<Image img={error_message} style={{maxWidth: 400}} />

Expand Down Expand Up @@ -119,7 +100,7 @@ Once the packages are installed, they will appear in the `./build/lfc_include/`
```
├── <Package Name>
│ ├── Installed Packages
│ │ ├── installed_package/
│ │ ├── <Installed Package>
│ │ │ ├── File_1.lf
│ │ │ │ ├── Rusable_Reactor_1.lf
│ │ │ │ ├── Rusable_Reactor_2.lf
Expand All @@ -131,17 +112,17 @@ Once the packages are installed, they will appear in the `./build/lfc_include/`

In this structure:
- **\<Package Name\>**: Represents the root folder of the main package.
- **<Installed Package>**: Represents each package listed in `Lingo.toml`, which contains one or more LF projects featuring reusable reactors.
- **\<Installed Package\>**: Represents each package listed in `Lingo.toml`, which contains one or more LF projects featuring reusable reactors.

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

<Image img={lingo_packages} style={{maxWidth: 400}} />

The hierarchy categorizes tree items into the following types:

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

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:

Expand Down Expand Up @@ -170,8 +151,8 @@ The **Local Libraries** section lists LF programs created by the developer, loca
│ │ │ ├── Rusable_Reactor_1.lf
│ │ │ ├── Rusable_Reactor_2.lf
│ │ ├── File_2.lf
│ │ │ ├── Rusable_Reactor_1.lf
│ │ │ ├── Rusable_Reactor_2.lf
│ │ │ ├── Rusable_Reactor_1.lf
│ │ │ ├── Rusable_Reactor_2.lf
...
```

Expand All @@ -181,8 +162,8 @@ The image below illustrates the **Local Libraries** section. In this depiction,

The hierarchy categorizes tree items into two types:

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

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

Expand Down
Loading