Skip to content

Commit 532ccaa

Browse files
committed
restructuring installation section
1 parent ab610b9 commit 532ccaa

File tree

1 file changed

+109
-16
lines changed

1 file changed

+109
-16
lines changed

docs/installation.md

Lines changed: 109 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,69 @@ You can also spin up one of our pre-configured Cloud-based dev environments:
2020

2121
Have a look at the [Lingua Franca playground](https://github.com/lf-lang/playground-lingua-franca) for more details.
2222

23+
## Compiler
24+
25+
There are multiple options available for installing the Lingua Franca compiler and other command line tools, as listed below. See the [handbook](./tools/command-line-tools.mdx) for usage instructions.
26+
27+
### Install Script
28+
29+
Run the following command in your terminal to install the latest release (on Windows, use WSL):
30+
31+
```
32+
curl -Ls https://install.lf-lang.org | bash -s cli
33+
```
34+
35+
You can also install the nightly pre-release:
36+
37+
```
38+
curl -Ls https://install.lf-lang.org | bash -s cli nightly
39+
```
40+
41+
You can use the `--prefix=<path>` argument to change the default install location.
42+
43+
### AUR
44+
45+
There are binary packages available in the Arch user repository, which you can install using your favorite AUR helper. For instance, with `yay`:
46+
47+
```
48+
yay -S lf-cli-bin
49+
```
50+
51+
or for the nightly pre-release:
52+
53+
```
54+
yay -S lf-cli-nightly-bin
55+
```
56+
57+
### Nixos
58+
59+
LFC is packaged in [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/development/compilers/lingua-franca/default.nix#L28) and is available via the binary cache.
60+
61+
Run
62+
```
63+
nix shell nixpkgs#lingua-franca
64+
```
65+
to temporarily install lfc in your current shell environment.
66+
67+
### Manual Download
68+
69+
Regular and nightly release builds of the command line tools can be downloaded from the [Lingua Franca release page](https://github.com/lf-lang/lingua-franca/releases). Download the archive that matches your OS and architecture, and extract the contents.
70+
71+
### From Source
72+
73+
Please refer to the [Lingua Franca GitHub repository](https://github.com/lf-lang/lingua-franca) for build instructions.
74+
75+
If you'd like to contribute to Lingua Franca, you can find details about the recommended developer setup here.
76+
77+
## Lingo the Lingua-Franca Package-Manager
78+
79+
Lingo is the package-manager and build tool of the lingua-franca ecosystem.
80+
81+
```
82+
cargo install lingua-franca
83+
PATH = $PATH:~/.cargo/bin
84+
```
85+
2386
## Visual Studio Code
2487

2588
Our Visual Studio Code extension can be installed via the Marketplace or built from source, as detailed below. See the [handbook](./tools/code-extension.mdx) for usage instructions.
@@ -99,56 +162,86 @@ open -a Epoch.app
99162

100163
Please refer to the [Epoch GitHub repository](https://github.com/lf-lang/epoch) for build instructions.
101164

102-
## CLI Tools
103165

104-
There are multiple options available for installing the Lingua Franca compiler and other command line tools, as listed below. See the [handbook](./tools/command-line-tools.mdx) for usage instructions.
166+
167+
168+
## Visual Studio Code
169+
170+
Our Visual Studio Code extension can be installed via the Marketplace or built from source, as detailed below. See the [handbook](./tools/code-extension.mdx) for usage instructions.
171+
172+
### Marketplace
173+
174+
The Lingua Franca extension is available on the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=lf-lang.vscode-lingua-franca) and the [VSX Registry](https://open-vsx.org/extension/lf-lang/vscode-lingua-franca). To install the extension, open VS Code, launch Quick Open (<kbd>Ctrl</kbd> + <kbd>P</kbd>) and enter:
175+
176+
```
177+
ext install lf-lang.vscode-lingua-franca
178+
```
179+
180+
Alternatively, you can run the following command in your terminal:
181+
182+
```
183+
code --install-extension lf-lang.vscode-lingua-franca
184+
```
185+
186+
To use the nightly pre-release of the extension instead of the latest release, find the Lingua Franca extension in the Extensions tab and click on the "Switch to Pre-Release Version" button.
187+
188+
### From Source
189+
190+
Please refer to the [Lingua Franca VS Code GitHub repository](https://github.com/lf-lang/vscode-lingua-franca) for build instructions.
191+
192+
## Epoch IDE
193+
194+
There are multiple options available for installing Epoch as listed below. See the handbook for usage instructions.
105195

106196
### Install Script
107197

108198
Run the following command in your terminal to install the latest release (on Windows, use WSL):
109199

110200
```
111-
curl -Ls https://install.lf-lang.org | bash -s cli
201+
curl -Ls https://install.lf-lang.org | bash -s epoch
112202
```
113203

114204
You can also install the nightly pre-release:
115-
116205
```
117-
curl -Ls https://install.lf-lang.org | bash -s cli nightly
206+
curl -Ls https://install.lf-lang.org | bash -s epoch nightly
118207
```
119208

120209
You can use the `--prefix=<path>` argument to change the default install location.
121210

211+
The default prefix is `/usr/local/bin` on a Mac and `~/.local/bin` on Linux and WSL. You may not have write access to this directory by default, in which case, if you still want to use the default prefix, you can replace `sh` with `sudo sh` in the above commands.
212+
122213
### AUR
123214

124215
There are binary packages available in the Arch user repository, which you can install using your favorite AUR helper. For instance, with `yay`:
125216

126217
```
127-
yay -S lf-cli-bin
218+
yay -S epoch-bin
128219
```
129220

130221
or for the nightly pre-release:
131222

132223
```
133-
yay -S lf-cli-nightly-bin
224+
yay -S epoch-nightly-bin
134225
```
135226

136-
### Nixos
227+
### Manual Download
137228

138-
LFC is packaged in [nixpkgs](https://github.com/NixOS/nixpkgs/blob/nixos-23.11/pkgs/development/compilers/lingua-franca/default.nix#L28) and is available via the binary cache.
229+
Regular and nightly release builds of Epoch can be downloaded from the [Epoch release page](https://github.com/lf-lang/epoch/releases). Download the archive that matches your OS and architecture, and extract the contents.
230+
231+
MacOS requires extra steps before being able to execute the app:
139232

140-
Run
141233
```
142-
nix shell nixpkgs#lingua-franca
234+
xattr -cr Epoch.app
143235
```
144-
to temporarily install lfc in your current shell environment.
145236

146-
### Manual Download
237+
To install, drag the Epoch.app file to your Applications folder. You can then invoke the app as follows:
147238

148-
Regular and nightly release builds of the command line tools can be downloaded from the [Lingua Franca release page](https://github.com/lf-lang/lingua-franca/releases). Download the archive that matches your OS and architecture, and extract the contents.
239+
```
240+
open -a Epoch.app
241+
```
149242

150243
### From Source
151244

152-
Please refer to the [Lingua Franca GitHub repository](https://github.com/lf-lang/lingua-franca) for build instructions.
245+
Please refer to the [Epoch GitHub repository](https://github.com/lf-lang/epoch) for build instructions.
246+
153247

154-
If you'd like to contribute to Lingua Franca, you can find details about the recommended developer setup here.

0 commit comments

Comments
 (0)