Skip to content

Commit

Permalink
Merge pull request #286 from lf-lang/rm-epoch
Browse files Browse the repository at this point in the history
Update installation instructions to no longer feature epoch
  • Loading branch information
lhstrh authored Sep 22, 2024
2 parents ce2e84f + 16eea94 commit 1a86674
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 86 deletions.
8 changes: 2 additions & 6 deletions docs/developer/downloading-and-building.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,5 @@ 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).

## Building IDEs

Currently, we provide two IDEs that support Lingua Franca programs.
Their source code is located in external repositories.
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).
Please refer to the READMEs for build instructions.
## 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.
55 changes: 0 additions & 55 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ The Lingua Franca toolchain requires Java 17 ([download from Oracle](https://www
You can use Lingua Franca:

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

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

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

## Epoch IDE

There are multiple options available for installing Epoch as listed below. See the handbook for usage instructions.

### Install Script

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

```
curl -Ls https://install.lf-lang.org | bash -s epoch
```

You can also install the nightly pre-release:
```
curl -Ls https://install.lf-lang.org | bash -s epoch nightly
```

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

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.

### AUR

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

```
yay -S epoch-bin
```

or for the nightly pre-release:

```
yay -S epoch-nightly-bin
```

### Manual Download

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.

MacOS requires extra steps before being able to execute the app:

```
xattr -cr Epoch.app
```

To install, drag the Epoch.app file to your Applications folder. You can then invoke the app as follows:

```
open -a Epoch.app
```

### From Source

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

## CLI Tools

Expand Down
4 changes: 0 additions & 4 deletions docs/legacy_routing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,6 @@ export default [
"to": "/deprecated",
"from": "/docs/handbook/language-specification"
},
{
"to": "/docs/tools/epoch-ide",
"from": "/docs/handbook/epoch-ide"
},
{
"to": "/docs/tools/code-extension",
"from": "/docs/handbook/code-extension"
Expand Down
4 changes: 0 additions & 4 deletions docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,10 +120,6 @@ const sidebars: SidebarsConfig = {
"type": "doc",
"id": "tools/code-extension"
},
{
"type": "doc",
"id": "tools/epoch-ide"
},
{
"type": "doc",
"id": "tools/command-line-tools"
Expand Down
10 changes: 0 additions & 10 deletions docs/tools/epoch-ide.mdx

This file was deleted.

8 changes: 3 additions & 5 deletions docs/tools/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,12 @@ $ lfc src/MyFile.lf
... successful compile ...
```

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.
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.

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:
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:

```
$ open -a epoch
$ code .
```

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.

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.
4 changes: 4 additions & 0 deletions docs/tutorial-videos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ A [video playlist](https://youtube.com/playlist?list=PL4zzL7roKtfXyKE3k8lOwPub9Y

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

:::warning
These videos mentioned Epoch, an IDE that is no longer actively maintained. We recommend using our VS Code extension instead.
:::

**Useful links:**

- [Complete video of part I](https://youtu.be/7vkhX5tS_oI)
Expand Down
2 changes: 1 addition & 1 deletion docs/writing-reactors/a-first-reactor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The [regression tests](https://github.com/lf-lang/lingua-franca/tree/master/test

## Structure of an LF Project

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:
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:

```
> lfc src/HelloWorld.lf
Expand Down
2 changes: 1 addition & 1 deletion docs/writing-reactors/distributed-execution.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ make
sudo make install
```

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).
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).

## Minimal Example

Expand Down

0 comments on commit 1a86674

Please sign in to comment.