Skip to content

Commit 6fa21f1

Browse files
vinzbarbutolhstrh
andauthored
Apply suggestions from code review
Co-authored-by: Marten Lohstroh <[email protected]>
1 parent ed2eb08 commit 6fa21f1

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

docs/glossary/glossary.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,15 @@ A source file with the `.lf` extension, representing a Lingua Franca (LF) progra
1212

1313
### Package
1414
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.
15-
The **package root** is the top-level directory where both the `Lingo.toml` file and the `src/` directory reside, serving as the main directory for the package.
15+
16+
### Package Root
17+
The **package root** is the top-level directory of a package where both the `Lingo.toml` file and the `src/` directory reside.
1618

1719
### Project
18-
Another term for a [package](#package).
20+
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].
1921

2022
### Library File
21-
An LF file containing one or more reactors intended for reuse, designed to be imported into multiple LF files.
23+
An LF file containing one or more reactors intended for reuse, designed to be imported into other LF files.
2224

2325
### Package Manager
2426
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.

docs/tools/code-extension.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ The Lingua Franca extension for Visual Studio Code (VS Code) provides syntax-dir
1212

1313
## Usage
1414

15-
### Creating a New Package
15+
### Creating a New Project
1616

17-
You can create a new LF [package](../glossary/glossary.mdx#package) either manually by creating an LF file or by using the [Lingo Package Manager](https://github.com/lf-lang/lingo).
17+
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).
1818

19-
#### Option 1: Create an LF Package Using the Lingo Package Manager
20-
1. After [installing the Lingo Package Manager](https://www.lf-lang.org/docs/installation#lingo), create an empty directory with the desired name for your LF package.
19+
#### Option 1: Create an Project Using the Lingo Package Manager
20+
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.
2121
2. Open the folder in VS Code.
2222
3. Open the terminal in this folder and run the <kbd>lingo init</kbd> command.
2323

@@ -30,7 +30,7 @@ This will set up a new LF package with the following structure:
3030
└── └── Lingo.toml # Configuration file for current package
3131
```
3232

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

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

4848
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.
4949

50-
### Opening an Existing LF package
50+
### Opening an Existing LF project
5151

52-
To open an existing LF package in VS Code, select the root directory of your Lingua Franca package as your workspace.
52+
To open an existing LF project in VS Code, select the [package root](../glossary/glossary.mdx#package-root) as your workspace.
5353

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

0 commit comments

Comments
 (0)