Skip to content

Commit 1a86674

Browse files
authored
Merge pull request #286 from lf-lang/rm-epoch
Update installation instructions to no longer feature epoch
2 parents ce2e84f + 16eea94 commit 1a86674

9 files changed

+11
-86
lines changed

docs/developer/downloading-and-building.mdx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,5 @@ However, we would suggest to choose an IDE that comes with good Java (and
5151
ideally Kotlin) support and that integrates well with Gradle.
5252
We recommend to use our [IntelliJ setup](../developer/developer-intellij-setup.mdx).
5353

54-
## Building IDEs
55-
56-
Currently, we provide two IDEs that support Lingua Franca programs.
57-
Their source code is located in external repositories.
58-
We have a [Lingua Franca extension](https://github.com/lf-lang/vscode-lingua-franca) for VS code and an Eclipse based IDE called [Epoch](https://github.com/lf-lang/epoch).
59-
Please refer to the READMEs for build instructions.
54+
## Building the VS Code extension
55+
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.

docs/installation.md

Lines changed: 0 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ The Lingua Franca toolchain requires Java 17 ([download from Oracle](https://www
99
You can use Lingua Franca:
1010

1111
- [in Visual Studio Code, using our extension](#visual-studio-code)
12-
- [using Epoch, an Eclipse-based IDE](#epoch-ide)
1312
- [using the command line](#cli-tools)
1413

1514
You can also spin up one of our pre-configured Cloud-based dev environments:
@@ -44,60 +43,6 @@ To use the nightly pre-release of the extension instead of the latest release, f
4443

4544
Please refer to the [Lingua Franca VS Code GitHub repository](https://github.com/lf-lang/vscode-lingua-franca) for build instructions.
4645

47-
## Epoch IDE
48-
49-
There are multiple options available for installing Epoch as listed below. See the handbook for usage instructions.
50-
51-
### Install Script
52-
53-
Run the following command in your terminal to install the latest release (on Windows, use WSL):
54-
55-
```
56-
curl -Ls https://install.lf-lang.org | bash -s epoch
57-
```
58-
59-
You can also install the nightly pre-release:
60-
```
61-
curl -Ls https://install.lf-lang.org | bash -s epoch nightly
62-
```
63-
64-
You can use the `--prefix=<path>` argument to change the default install location.
65-
66-
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.
67-
68-
### AUR
69-
70-
There are binary packages available in the Arch user repository, which you can install using your favorite AUR helper. For instance, with `yay`:
71-
72-
```
73-
yay -S epoch-bin
74-
```
75-
76-
or for the nightly pre-release:
77-
78-
```
79-
yay -S epoch-nightly-bin
80-
```
81-
82-
### Manual Download
83-
84-
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.
85-
86-
MacOS requires extra steps before being able to execute the app:
87-
88-
```
89-
xattr -cr Epoch.app
90-
```
91-
92-
To install, drag the Epoch.app file to your Applications folder. You can then invoke the app as follows:
93-
94-
```
95-
open -a Epoch.app
96-
```
97-
98-
### From Source
99-
100-
Please refer to the [Epoch GitHub repository](https://github.com/lf-lang/epoch) for build instructions.
10146

10247
## CLI Tools
10348

docs/legacy_routing.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ export default [
1111
"to": "/deprecated",
1212
"from": "/docs/handbook/language-specification"
1313
},
14-
{
15-
"to": "/docs/tools/epoch-ide",
16-
"from": "/docs/handbook/epoch-ide"
17-
},
1814
{
1915
"to": "/docs/tools/code-extension",
2016
"from": "/docs/handbook/code-extension"

docs/sidebars.ts

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,10 +120,6 @@ const sidebars: SidebarsConfig = {
120120
"type": "doc",
121121
"id": "tools/code-extension"
122122
},
123-
{
124-
"type": "doc",
125-
"id": "tools/epoch-ide"
126-
},
127123
{
128124
"type": "doc",
129125
"id": "tools/command-line-tools"

docs/tools/epoch-ide.mdx

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/tools/troubleshooting.mdx

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,12 @@ $ lfc src/MyFile.lf
2020
... successful compile ...
2121
```
2222

23-
If you then have trouble compiling the same file using [Epoch](../tools/epoch-ide.mdx) or the [Visual Studio Code extension](../tools/code-extension.mdx), then those tools are executing in a different environment that may not have the same `PATH` variable and may, for example, fail to find some external program or invoke a different version of that program.
23+
If you then have trouble compiling the same file using the [Visual Studio Code extension](../tools/code-extension.mdx), then it is executing in a different environment that may not have the same `PATH` variable and may, for example, fail to find some external program or invoke a different version of that program.
2424

25-
On many platforms, one way to ensure that [Epoch](../tools/epoch-ide.mdx) and the [Visual Studio Code extension](../tools/code-extension.mdx) use the same environment as the command-line tools is to invoke them on the command line. For example, on a Mac, you can invoke Epoch and Visual Studio Code as follows:
25+
On many platforms, one way to ensure that the [Visual Studio Code extension](../tools/code-extension.mdx) uses the same environment as the command-line tools, is to invoke them on the command line. For example:
2626

2727
```
28-
$ open -a epoch
2928
$ code .
3029
```
3130

32-
This way, the tools inherit the environment from the shell from which you invoke them. Often, that environment is quite different from what you get if, for example, you invoke the tools by double clicking on their icons.
33-
31+
This way, the tool inherits the environment from the shell from which you invoke it. Often, that environment is quite different from what you get if, for example, you launch the shell from the graphical user interface.

docs/tutorial-videos.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ A [video playlist](https://youtube.com/playlist?list=PL4zzL7roKtfXyKE3k8lOwPub9Y
2121

2222
This part briefly describes the background of the project and explains how to get started with the software.
2323

24+
:::warning
25+
These videos mentioned Epoch, an IDE that is no longer actively maintained. We recommend using our VS Code extension instead.
26+
:::
27+
2428
**Useful links:**
2529

2630
- [Complete video of part I](https://youtu.be/7vkhX5tS_oI)

docs/writing-reactors/a-first-reactor.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The [regression tests](https://github.com/lf-lang/lingua-franca/tree/master/test
3737

3838
## Structure of an LF Project
3939

40-
The Lingua Franca tools assume that LF programs are put into a file with a `.lf` extension that is stored somewhere within a directory called `src`. To compile and run the above example, choose a **project root** directory, create a `src` directory within that, and put the above code into a file called, say, `src/HelloWorld.lf`. You can compile the code on the [command line](../tools/command-line-tools.mdx), within [Visual Studio Code](../tools/code-extension.mdx), or within the [Epoch IDE](../tools/epoch-ide.mdx). On the command line this will look like this:
40+
The Lingua Franca tools assume that LF programs are put into a file with a `.lf` extension that is stored somewhere within a directory called `src`. To compile and run the above example, choose a **project root** directory, create a `src` directory within that, and put the above code into a file called, say, `src/HelloWorld.lf`. You can compile the code on the [command line](../tools/command-line-tools.mdx) or within [Visual Studio Code](../tools/code-extension.mdx). On the command line this will look like this:
4141

4242
```
4343
> lfc src/HelloWorld.lf

docs/writing-reactors/distributed-execution.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ make
3737
sudo make install
3838
```
3939

40-
The above will create a program called `RTI` and install it at `/usr/local/bin/RTI`. Once this program is available in your path, you can compile and execute federated Lingua Franca programs using [Epoch, VS Code, or the command-line tools](/docs/installation). For more details, see the [README file](https://github.com/lf-lang/reactor-c/blob/main/core/federated/RTI/README.md).
40+
The above will create a program called `RTI` and install it at `/usr/local/bin/RTI`. Once this program is available in your path, you can compile and execute federated Lingua Franca programs using [VS Code or the command-line tools](/docs/installation). For more details, see the [README file](https://github.com/lf-lang/reactor-c/blob/main/core/federated/RTI/README.md).
4141

4242
## Minimal Example
4343

0 commit comments

Comments
 (0)