-
Notifications
You must be signed in to change notification settings - Fork 18
Linux related #55
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Linux related #55
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
73 changes: 73 additions & 0 deletions
73
packages/documentation/copy/en/developer/Getting_Started_Linux.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
--- | ||
title: Getting started on Linux | ||
layout: docs | ||
permalink: /docs/handbook/getting-started-linux | ||
oneline: "Quick start with Lingua Franca on Linux" | ||
preamble: > | ||
--- | ||
|
||
# Getting started on Linux | ||
|
||
## Installation | ||
|
||
### Debian & Other | ||
|
||
Sadly there are currently no packaged version of the lingua-franca compiler in debian distributions so there is | ||
really only the manual way. But we offer prebuild binaries [here](https://github.com/lf-lang/lingua-franca/releases). | ||
Please note that you need a modern version of java 17 or greater. | ||
|
||
If you want to compile the lingua-franca compiler from scratch there is a [guide](/docs/handbook/download) for that. | ||
Alternatively you can use the prebuild lfc. | ||
|
||
**Short instructions for downloading lfc** | ||
```bash | ||
wget https://github.com/lf-lang/lingua-franca/releases/download/v0.2.0/lfc_0.2.0.tar.gz | ||
tar xf lfc_0.2.0.tar.gz | ||
export PATH="$(pwd)/lfc_0.2.0/bin/":$PATH // maybe add that to you bashrc/zshrc aliases | ||
lfc ./src/yourproject.lf | ||
``` | ||
|
||
### Arch | ||
|
||
There are packaged version of [lfc](https://aur.archlinux.org/packages/lfc-bin) and [epoch](https://aur.archlinux.org/packages/epoch-bin) the arch user repository. | ||
|
||
```bash | ||
yay -S lfc-bin | ||
``` | ||
|
||
Alternatively you can install it by hand. | ||
|
||
```bash | ||
git clone https://aur.archlinux.org/packages/lfc-bin | ||
cd lfc-bin | ||
makepkg -si | ||
``` | ||
|
||
### Nixos | ||
|
||
For nixos users there is a already a package since the **nixos-22.05** release. Lingua-franca develops quite rapidly so the version packaged for nixpkgs may lack behind. | ||
|
||
tanneberger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
``` | ||
nix-shell -p lingua-franca | ||
lfc ./src/youproject.lf | ||
``` | ||
|
||
If you want to use the cpp-target and are using nix there is already great tooling built for this [here](https://github.com/lf-lang/reactor-cpp/blob/master/CONTRIBUTING.md). | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The above presumably not include LF. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the commands above show how you temporarily install lfc into your shell environment. |
||
## Development | ||
|
||
### Vim | ||
tanneberger marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
There is an simple Vim syntax highlighting [plugin](https://github.com/lf-lang/lingua-franca.vim). | ||
This vim plugin can also be found inside the nixpkgs (`vimPlugins.lingua-franca-vim`). | ||
|
||
### Integrated Development Environments | ||
|
||
Lingua-Franca has integration's into two big ides [epoch](/docs/handbook/epoch-ide)(modified version of eclipse) or a [vs-code plugin](/docs/handbook/code-extension). | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason for manually downloading and building the package instead of using an AUR helper like
yay
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There shouldn't be :-) We should write some distro-specific instructions for cases where installation can be done with a simple one-liner.