Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
59 changes: 59 additions & 0 deletions docs/developer/documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Documentation
description: Pointers to Lingua Franca documentation, source repositories, examples, and templates.
---

This page collects pointers to Lingua Franca documentation, source repositories, examples, and templates.

## User Documentation

- [Lingua Franca user documentation](https://lf-lang.org)
- [micro-LF user documentation](https://micro-lf.org)

## Code Documentation

- [lingua-franca code generator](https://lf-lang.org/lingua-franca)
- [reactor-c runtime system](https://lf-lang.org/reactor-c)
- [reactor-uc runtime system](https://dev.micro-lf.org) (used by micro-LF)

## Main GitHub Repositories

- [lingua-franca](https://github.com/lf-lang/lingua-franca): code generator
- [vscode-lingua-franca](https://github.com/lf-lang/vscode-lingua-franca): Visual Studio Code extension
- [reactor-c](https://github.com/lf-lang/reactor-c): runtime system for the C target
- [reactor-uc](https://github.com/lf-lang/reactor-uc): runtime system for micro-LF
- [lf-python-support](https://github.com/lf-lang/lf-python-support): runtime support for the Python target
- [reactor-cpp](https://github.com/lf-lang/reactor-cpp): runtime system for C++
- [reactor-ts](https://github.com/lf-lang/reactor-ts): runtime system for the TypeScript target
- [reactor-rs](https://github.com/lf-lang/reactor-rs): runtime system for the Rust target
- [release-tools](https://github.com/lf-lang/release-tools): release tools

## GitHub Repositories with Examples

- [playground-lingua-franca](https://github.com/lf-lang/playground-lingua-franca): Collection of Lingua Franca examples
- [curated-c](https://github.com/lf-lang/curated-c): context for AI-assisted design in the C target
- [curated-py](https://github.com/lf-lang/curated-py): context for AI-assisted design in the Python target
- [pkgs](https://github.com/lf-lang/pkgs): main packages directory, with pointers to packages
- [lf-demos](https://github.com/lf-lang/lf-demos): demo programs from talks and tutorials

## GitHub Repositories for Web Pages

- [lf-lang.github.io](https://github.com/lf-lang/lf-lang.github.io): lf-lang.org web page
- [micro-lf-documentation](https://github.com/lf-lang/micro-lf-documentation): micro-lf.org web page

## Templates for Embedded Processors using the C Target

- [lf-pico-template](https://github.com/lf-lang/lf-pico-template): Raspberry Pi Pico
- [lf-3pi-template](https://github.com/lf-lang/lf-3pi-template): Pololu 3-Pi robot
- [lf-west-template](https://github.com/lf-lang/lf-west-template): Zephyr development
- [lf-patmos-template](https://github.com/lf-lang/lf-patmos-template): Patmos processor

## Templates for Embedded Processors using micro-LF

- [ulf-posix-template](https://github.com/lf-lang/ulf-posix-template): micro-LF development on macOS or Linux
- [ulf-freertos-template](https://github.com/lf-lang/ulf-freertos-template): FreeRTOS
- [ulf-zephyr-template](https://github.com/lf-lang/ulf-zephyr-template): Zephyr
- [ulf-riot-template](https://github.com/lf-lang/ulf-riot-template): RIOT
- [ulf-esp-idf-template](https://github.com/lf-lang/ulf-esp-idf-template): ESP-IDF
- [ulf-patmos-template](https://github.com/lf-lang/ulf-patmos-template): Patmos processor
- [ulf-pico-template](https://github.com/lf-lang/ulf-pico-template): Raspberry Pi Pico
7 changes: 4 additions & 3 deletions docs/developer/downloading-and-building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,10 @@ Thus, you can choose if you want to use `bin/lfc-dev`, which first builds `lfc`
## IDE Integration

You can use any editor or IDE that you like to work with the code base.
However, we would suggest to choose an IDE that comes with good Java (and
ideally Kotlin) support and that integrates well with Gradle.
We recommend to use our [IntelliJ setup](../developer/developer-intellij-setup.mdx).
However, we suggest choosing an IDE with good Java and
Kotlin support and that integrates well with Gradle.
[Visual Studio Code](https://code.visualstudio.com) and [Cursor](https://cursor.com/sdk) are both good choices, particularly because the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code provides a rich set of features for working with Lingua Franca code, including automatic diagram generation.
You can also use our [IntelliJ setup](../developer/developer-intellij-setup.mdx).

## Building the VS Code extension
To build the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code, refer to the README in the source repository.
2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ const sidebars: SidebarsConfig = {
},
{
"type": "doc",
"id": "developer/developer-eclipse-setup-with-oomph"
"id": "developer/documentation"
},
{
"type": "doc",
Expand Down
59 changes: 59 additions & 0 deletions versioned_docs/version-0.13.0/developer/documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: Documentation
description: Pointers to Lingua Franca documentation, source repositories, examples, and templates.
---

This page collects pointers to Lingua Franca documentation, source repositories, examples, and templates.

## User Documentation

- [Lingua Franca user documentation](https://lf-lang.org)
- [micro-LF user documentation](https://micro-lf.org)

## Code Documentation

- [lingua-franca code generator](https://lf-lang.org/lingua-franca)
- [reactor-c runtime system](https://lf-lang.org/reactor-c)
- [reactor-uc runtime system](https://dev.micro-lf.org) (used by micro-LF)

## Main GitHub Repositories

- [lingua-franca](https://github.com/lf-lang/lingua-franca): code generator
- [vscode-lingua-franca](https://github.com/lf-lang/vscode-lingua-franca): Visual Studio Code extension
- [reactor-c](https://github.com/lf-lang/reactor-c): runtime system for the C target
- [reactor-uc](https://github.com/lf-lang/reactor-uc): runtime system for micro-LF
- [lf-python-support](https://github.com/lf-lang/lf-python-support): runtime support for the Python target
- [reactor-cpp](https://github.com/lf-lang/reactor-cpp): runtime system for C++
- [reactor-ts](https://github.com/lf-lang/reactor-ts): runtime system for the TypeScript target
- [reactor-rs](https://github.com/lf-lang/reactor-rs): runtime system for the Rust target
- [release-tools](https://github.com/lf-lang/release-tools): release tools

## GitHub Repositories with Examples

- [playground-lingua-franca](https://github.com/lf-lang/playground-lingua-franca): Collection of Lingua Franca examples
- [curated-c](https://github.com/lf-lang/curated-c): context for AI-assisted design in the C target
- [curated-py](https://github.com/lf-lang/curated-py): context for AI-assisted design in the Python target
- [pkgs](https://github.com/lf-lang/pkgs): main packages directory, with pointers to packages
- [lf-demos](https://github.com/lf-lang/lf-demos): demo programs from talks and tutorials

## GitHub Repositories for Web Pages

- [lf-lang.github.io](https://github.com/lf-lang/lf-lang.github.io): lf-lang.org web page
- [micro-lf-documentation](https://github.com/lf-lang/micro-lf-documentation): micro-lf.org web page

## Templates for Embedded Processors using the C Target

- [lf-pico-template](https://github.com/lf-lang/lf-pico-template): Raspberry Pi Pico
- [lf-3pi-template](https://github.com/lf-lang/lf-3pi-template): Pololu 3-Pi robot
- [lf-west-template](https://github.com/lf-lang/lf-west-template): Zephyr development
- [lf-patmos-template](https://github.com/lf-lang/lf-patmos-template): Patmos processor

## Templates for Embedded Processors using micro-LF

- [ulf-posix-template](https://github.com/lf-lang/ulf-posix-template): micro-LF development on macOS or Linux
- [ulf-freertos-template](https://github.com/lf-lang/ulf-freertos-template): FreeRTOS
- [ulf-zephyr-template](https://github.com/lf-lang/ulf-zephyr-template): Zephyr
- [ulf-riot-template](https://github.com/lf-lang/ulf-riot-template): RIOT
- [ulf-esp-idf-template](https://github.com/lf-lang/ulf-esp-idf-template): ESP-IDF
- [ulf-patmos-template](https://github.com/lf-lang/ulf-patmos-template): Patmos processor
- [ulf-pico-template](https://github.com/lf-lang/ulf-pico-template): Raspberry Pi Pico
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,10 @@ Thus, you can choose if you want to use `bin/lfc-dev`, which first builds `lfc`
## IDE Integration

You can use any editor or IDE that you like to work with the code base.
However, we would suggest to choose an IDE that comes with good Java (and
ideally Kotlin) support and that integrates well with Gradle.
We recommend to use our [IntelliJ setup](../developer/developer-intellij-setup.mdx).
However, we suggest choosing an IDE with good Java and
Kotlin support and that integrates well with Gradle.
[Visual Studio Code](https://code.visualstudio.com) and [Cursor](https://cursor.com/sdk) are both good choices, particularly because the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code provides a rich set of features for working with Lingua Franca code, including automatic diagram generation.
You can also use our [IntelliJ setup](../developer/developer-intellij-setup.mdx).

## Building the VS Code extension
To build the [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS Code, refer to the README in the source repository.
2 changes: 1 addition & 1 deletion versioned_sidebars/version-0.13.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@
},
{
"type": "doc",
"id": "developer/developer-eclipse-setup-with-oomph"
"id": "developer/documentation"
},
{
"type": "doc",
Expand Down
Loading