From 308d5d511621d8375d7be7b2f118ceee4ca18fb8 Mon Sep 17 00:00:00 2001 From: revol-xut Date: Tue, 3 May 2022 14:20:10 +0200 Subject: [PATCH 1/5] first draft --- .../en/developer/Getting_Started_Linux.md | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 packages/documentation/copy/en/developer/Getting_Started_Linux.md diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md b/packages/documentation/copy/en/developer/Getting_Started_Linux.md new file mode 100644 index 000000000..2f1e259a8 --- /dev/null +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md @@ -0,0 +1,68 @@ +--- +title: Getting started on Linux +layout: docs +permalink: /docs/handbook/download +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 11 or greater. + +If you want to compile the lingua-franca compiler from scratch there is a [guide](Downloading\ and\ Building.md) for that. + +``` + 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 + 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 **22.05** release. Because this is a very fast developing project +the version is nixpkgs is always lacking behind a little bit. + +``` + 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). + +## Development + + +### Vim + +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](../tools/Epoch IDE.md)(modified version of eclipse) or a [vs-code plugin](../tools/Code\ Extension.md). + + + + + + + From ea06bb08e8a16bd9a53e5c5cff3a97e875459ae6 Mon Sep 17 00:00:00 2001 From: Marten Lohstroh Date: Tue, 3 May 2022 15:21:54 -0700 Subject: [PATCH 2/5] Apply suggestions from code review Co-authored-by: Edward A. Lee --- .../documentation/copy/en/developer/Getting_Started_Linux.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md b/packages/documentation/copy/en/developer/Getting_Started_Linux.md index 2f1e259a8..65857aeb8 100644 --- a/packages/documentation/copy/en/developer/Getting_Started_Linux.md +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md @@ -1,7 +1,7 @@ --- title: Getting started on Linux layout: docs -permalink: /docs/handbook/download +permalink: /docs/handbook/getting-started-linux oneline: "Quick start with Lingua Franca on Linux" preamble: > --- @@ -14,7 +14,7 @@ preamble: > 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 11 or greater. +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](Downloading\ and\ Building.md) for that. From 63704d7ff9193da05746a816d45aa1703991b52a Mon Sep 17 00:00:00 2001 From: revol-xut Date: Wed, 4 May 2022 12:38:43 +0200 Subject: [PATCH 3/5] fixed some suggestions --- .../copy/en/developer/Getting_Started_Linux.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md b/packages/documentation/copy/en/developer/Getting_Started_Linux.md index 65857aeb8..38b422057 100644 --- a/packages/documentation/copy/en/developer/Getting_Started_Linux.md +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md @@ -16,7 +16,7 @@ Sadly there are currently no packaged version of the lingua-franca compiler in d 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](Downloading\ and\ Building.md) for that. +If you want to compile the lingua-franca compiler from scratch there is a [guide](/docs/handbook/download) for that. ``` wget https://github.com/lf-lang/lingua-franca/releases/download/v0.2.0/lfc_0.2.0.tar.gz @@ -37,8 +37,7 @@ There are packaged version of [lfc](https://aur.archlinux.org/packages/lfc-bin) ### Nixos -For nixos users there is a already a package since the **22.05** release. Because this is a very fast developing project -the version is nixpkgs is always lacking behind a little bit. +For nixos users there is a already a package since the **nixos-22.05** release. Lingua-franca developes quite rapidly so the version packaged for nixpkgs may lack behind. ``` nix-shell -p lingua-franca @@ -49,16 +48,9 @@ If you want to use the cpp-target and are using nix there is already great tooli ## Development - -### Vim - -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](../tools/Epoch IDE.md)(modified version of eclipse) or a [vs-code plugin](../tools/Code\ Extension.md). +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). From b6b845ff4b76d77959eb516e617c6b0525481350 Mon Sep 17 00:00:00 2001 From: revol-xut Date: Wed, 4 May 2022 17:09:45 +0200 Subject: [PATCH 4/5] fixed suggestions --- .../en/developer/Getting_Started_Linux.md | 9 ++- .../en/developer/Getting_Started_Linux.md.bak | 68 +++++++++++++++++++ 2 files changed, 76 insertions(+), 1 deletion(-) create mode 100644 packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md b/packages/documentation/copy/en/developer/Getting_Started_Linux.md index 38b422057..4b7111c7d 100644 --- a/packages/documentation/copy/en/developer/Getting_Started_Linux.md +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md @@ -17,8 +17,10 @@ really only the manual way. But we offer prebuild binaries [here](https://github 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 @@ -48,6 +50,11 @@ If you want to use the cpp-target and are using nix there is already great tooli ## Development +### Vim + +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). diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak b/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak new file mode 100644 index 000000000..75bf73349 --- /dev/null +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak @@ -0,0 +1,68 @@ +--- +title: Getting started Linux +layout: docs +permalink: /docs/handbook/download +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 11 or greater. + +If you want to compile the lingua-franca compiler from skratch there is a [guide](Downloading\ and\ Building.md) for that. + +``` + 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 + 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 **22.05** release. Because this is a very fast developing project +the version is nixpkgs is always lacking behind a little bit. + +``` + 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). + +## Development + + +### Vim + +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 Enivroments + +Lingua-Franca has integrations into two big ides [epoch](../tools/Epoch IDE.md)(modified version of eclipse) or a [vs-code plugin](../tools/Code\ Extension.md). + + + + + + + From 597dc8a0580963606862738bf954c297a698bea4 Mon Sep 17 00:00:00 2001 From: revol-xut Date: Sun, 24 Jul 2022 22:09:02 +0200 Subject: [PATCH 5/5] removing unused file and add installation via yay --- .../en/developer/Getting_Started_Linux.md | 8 ++- .../en/developer/Getting_Started_Linux.md.bak | 68 ------------------- 2 files changed, 7 insertions(+), 69 deletions(-) delete mode 100644 packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md b/packages/documentation/copy/en/developer/Getting_Started_Linux.md index 4b7111c7d..d1b173f44 100644 --- a/packages/documentation/copy/en/developer/Getting_Started_Linux.md +++ b/packages/documentation/copy/en/developer/Getting_Started_Linux.md @@ -31,6 +31,12 @@ Alternatively you can use the prebuild lfc. 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 @@ -39,7 +45,7 @@ There are packaged version of [lfc](https://aur.archlinux.org/packages/lfc-bin) ### Nixos -For nixos users there is a already a package since the **nixos-22.05** release. Lingua-franca developes quite rapidly so the version packaged for nixpkgs may lack behind. +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. ``` nix-shell -p lingua-franca diff --git a/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak b/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak deleted file mode 100644 index 75bf73349..000000000 --- a/packages/documentation/copy/en/developer/Getting_Started_Linux.md.bak +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: Getting started Linux -layout: docs -permalink: /docs/handbook/download -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 11 or greater. - -If you want to compile the lingua-franca compiler from skratch there is a [guide](Downloading\ and\ Building.md) for that. - -``` - 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 - 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 **22.05** release. Because this is a very fast developing project -the version is nixpkgs is always lacking behind a little bit. - -``` - 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). - -## Development - - -### Vim - -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 Enivroments - -Lingua-Franca has integrations into two big ides [epoch](../tools/Epoch IDE.md)(modified version of eclipse) or a [vs-code plugin](../tools/Code\ Extension.md). - - - - - - -