-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reviewing content for 4.5, part2 (#1111)
Co-authored-by: Stefan Kruger <stefan@dyalog.com>
- Loading branch information
Showing
7 changed files
with
142 additions
and
1,183 deletions.
There are no files selected for viewing
This file contains 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
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains 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 |
|---|---|---|
| @@ -1,119 +1,66 @@ | ||
| # Installation | ||
|
|
||
| This chapter describes how to install the RIDE. | ||
| ## Font and Keyboard Support | ||
|
|
||
| ## Pre-requisites | ||
| If Dyalog is not installed on the machine that RIDE is being installed on, then the APL385 Unicode font and keyboard mappings installed with RIDE mean that they are available within RIDE. However, to be able to enter APL glyphs outside RIDE, see [APL Fonts and Keyboards](https://www.dyalog.com/apl-font-keyboard.htm). | ||
|
|
||
| RIDE can only connect to a Dyalog interpreter that is version 15.0 or later. | ||
| ## Zero-Footprint | ||
|
|
||
| The RIDE is supported on the following operating systems: | ||
|
|
||
| - Linux x86_64 – the following distributions: | ||
| - Debian 8 onwards | ||
| - Fedora 25 onwards | ||
| - Ubuntu 14.04 onwards | ||
|
|
||
| distributions built on top of these should also work (Linux distribution must also have libnss version 3.26 onwards) | ||
|
|
||
| - macOS – Yosemite onwards | ||
| - Microsoft Windows – Windows 7 onwards | ||
|
|
||
| For the zero-footprint RIDE: | ||
|
|
||
| - a compatible browser must be installed. | ||
| - the operating system must be supported by the underlying [technology](https://electronjs.org). | ||
|
|
||
| If Dyalog is not installed on the machine that the RIDE is being installed on, then the APL385 font and keyboard mappings installed with the RIDE mean that they are available when running a Dyalog Session through the RIDE. However, to be able to enter APL glyphs outside a Dyalog Session (for example, in text files or emails) you will need to download and install the [appropriate files](https://www.dyalog.com/apl-font-keyboard.htm) for your system. | ||
|
|
||
| ## Installing the RIDE | ||
|
|
||
| Installation instructions are dependent on operating system. | ||
|
|
||
| ### Zero Footprint | ||
|
|
||
| The use of the RIDE from a browser requires no installation on the machine where the RIDE will run. However, the RIDE must be installed on the machine where APL is installed, so that Dyalog can act as a web server, making the necessary files available to the browser. | ||
| The use of RIDE from a browser requires no installation on the machine where RIDE will run; all you need is a modern browser. | ||
|
|
||
| !!!note | ||
| When installing the RIDE, if you select the default location suggested by the installer then APL can be launched as a RIDE server without creating a [configuration file](sample_configuration_file.md). | ||
| When installing RIDE, if you select the default location suggested by the installer then APL can be launched as a RIDE server without creating a [configuration file](sample_configuration_file.md). | ||
|
|
||
| On non-Windows platforms, the Zero Footprint RIDE is automatically installed to the default location (**[DYALOG]/RIDEapp**) when Dyalog is installed and no additional installation is necessary to use the [Zero Footprint RIDE](the_zero_footprint_ride.md) from a browser. | ||
| On non-Windows platforms, zero-footprint RIDE is automatically installed to the default location (**[DYALOG]/RIDEapp**) when Dyalog is installed and no additional installation is necessary. On Windows, zero-footprint RIDE needs separate installation. | ||
|
|
||
| ### Installing on Linux | ||
| For details, see [Zero Footprint RIDE](the_zero_footprint_ride.md). | ||
|
|
||
| The installation process for the RIDE is the same irrespective of whether it is installed as a stand-alone product or on a machine that already has Dyalog installed. | ||
| ## Linux | ||
|
|
||
| --- | ||
| **To install the RIDE** | ||
| RIDE requires Debian 8+, Fedora 14.04+, or Ubuntu 10.10+. Distributions built on top of the above should also work, provided that they have libnss version 3.26 or newer. | ||
|
|
||
| 1. Download the RIDE's **.deb** or **.rpm** file (whichever is appropriate for your Linux distribution) from the [RIDE releases page](https://github.com/Dyalog/ride/releases). If your Linux distribution does not support either **.deb** or **.rpm** files, then please contact support@dyalog.com. | ||
| 1. Download the **.deb** or **.rpm** file (whichever is appropriate for your Linux distribution) from the [RIDE releases page](https://github.com/Dyalog/ride/releases). If your Linux distribution does not support either **.deb** or **.rpm** files, then please contact support@dyalog.com. | ||
| 2. From the command line, use standard installation commands to install the package. | ||
|
|
||
| The RIDE is now installed and ready to use. The RIDE icon (shortcut) is added to the desktop. | ||
| A RIDE shortcut is added to the desktop. | ||
|
|
||
| --- | ||
| ## macOS | ||
|
|
||
| ### Installing on macOS | ||
| RIDE requires macOS Yosemite (10.10) or better. | ||
|
|
||
| The RIDE is the default UI for Dyalog on macOS and is installed at the same time as Dyalog (see the [Dyalog for macOS Installation and Configuration Guide](https://docs.dyalog.com/latest/Dyalog%20for%20macOS%20Installation%20and%20Configuration%20Guide.pdf)); no further installation is required. | ||
|
|
||
| --- | ||
| **To install the RIDE as a separate, stand-alone, product** | ||
|
|
||
| 1. Download the RIDE's **.pkg** file from the [RIDE releases page](https://github.com/Dyalog/ride/releases). | ||
| 2. Double-click on the RIDE's **.pkg** file. | ||
|
|
||
| The **RIDE Installer** window is displayed. | ||
| You can also install RIDE as a separate, stand-alone, product, for example to work exclusively with remote APL interpreters: | ||
|
|
||
| 3. Follow the instructions in the RIDE Installer window to successful completion of the installation process. | ||
| 1. Download the **.pkg** file from the [RIDE releases page](https://github.com/Dyalog/ride/releases). | ||
| 2. Double-click on RIDE's **.pkg** file. | ||
| 3. Follow the instructions. | ||
|
|
||
| The RIDE is now installed and ready to use. The RIDE icon is added to the **Applications** directory (accessed by selecting **Applications** from the **Go** menu in the **Finder** menu bar). | ||
| RIDE is added to the **Applications** directory (accessed by selecting **Applications** from the **Go** menu in the **Finder** menu bar, or by activating Spotlight with <kbd>⌘</kbd>+<kbd>Space</kbd> and typing RIDE). | ||
|
|
||
| --- | ||
| Starting RIDE will add RIDE's icon to the temporary "Recently Used Apps" area to the right of the dock. To keep the RIDE icon in the dock permanently, right-click on the icon and select `Options > Keep in Dock` from the drop-down list that appears. | ||
|
|
||
| Starting the RIDE adds its icon to the dock. To keep the RIDE icon in the dock permanently, right-click on the icon and select **Options > Keep in Dock** from the drop-down list that appears. | ||
| ## Windows | ||
|
|
||
| ### Installing on Microsoft Windows | ||
| RIDE requires Windows 7 or newer. | ||
|
|
||
| The installation process for the RIDE is the same irrespective of whether it is installed as a stand-alone product or on a machine that already has Dyalog installed. | ||
|
|
||
| --- | ||
| **To install the RIDE** | ||
|
|
||
| 1. Download the RIDE's **.zip** file from the [RIDE releases page](https://github.com/Dyalog/ride/releases). | ||
| 1. Download the **.zip** file from the [RIDE releases page](https://github.com/Dyalog/ride/releases). | ||
| 2. Unzip the downloaded **.zip** file, placing the `setup_ride.exe` and `setup_ride.msi` files in the same location as each other. | ||
| 3. Double-click on the `setup_ride.exe` file. | ||
| 4. Follow the instructions. | ||
|
|
||
| The **RIDE Installation window** is displayed. | ||
| 4. Follow the instructions in the RIDE Installation window to successful completion of the installation process. | ||
|
|
||
| The RIDE is now installed and ready to use. The RIDE icon (shortcut) is added to the desktop. | ||
|
|
||
| --- | ||
| A RIDE shortcut is added to the desktop | ||
|
|
||
| ## Configuration (.ini) File | ||
|
|
||
| A **.ini** configuration file can be used to define settings for the `RIDE_INIT` configuration parameter. By default, the interpreter will look for a **ride.ini** file in: | ||
|
|
||
| - the directory in which the default session and log files are stored, for example, **C:\Users\JohnDoe\AppData\Local\Programs\Dyalog** (on Microsoft Windows) | ||
| - **$HOME/.dyalog** (on IBM AIX, macOS and Linux) | ||
| - **$HOME/.dyalog** (on all other platforms) | ||
|
|
||
| This file is not automatically created by Dyalog but can be created manually. Examples of the fields that you might want to include within the **.ini** configuration file are included in the [sample configuration file](sample_configuration_file.md). | ||
|
|
||
| A different name and location for the .ini configuration file can be specified by including a second `mode`, `CONFIG`, in the [RIDE_INIT](ride_init.md) parameter and setting it so that `CONFIG=<filename>`, where `<filename>` is the fully-qualified path to, and name of, a **.ini** configuration file containing name-value pairs related to mode, certificate details, and so on. | ||
|
|
||
| !!!note | ||
| The **.ini** configuration file must be located on the machine on which the interpreter is running (this is not necessarily the same machine as the one on which the RIDE is running). | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| The **.ini** configuration file must be located on the machine on which the interpreter is running (this is not necessarily the same machine as the one on which RIDE is running). |
This file contains 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 |
|---|---|---|
| @@ -1,24 +1,12 @@ | ||
| # Introduction | ||
|
|
||
| !!!note | ||
| The use of the RIDE is subject to the conditions of the [MIT licence](https://github.com/Dyalog/ride/blob/master/licence). The installation and use of the RIDE does not convey any additional rights to use Dyalog or any other Dyalog products. Specifically, although the interpreter can be configured to allow the RIDE to debug runtime executables, you should only do this if your Dyalog licence also allows it. | ||
| The use of RIDE is subject to the conditions of the [MIT licence](https://github.com/Dyalog/ride/blob/master/licence). The installation and use of RIDE does not convey any additional rights to use Dyalog or any other Dyalog products. Specifically, although the interpreter can be configured to allow RIDE to debug runtime executables, you should only do this if your Dyalog licence also allows it. | ||
|
|
||
| The Remote Integrated Development Environment (RIDE) is a cross-platform, graphical development environment capable of producing a rich user experience on a variety of platforms. It supports the interactive use of APL notation to explore data, discover algorithms and create solutions – or diagnose problems, resolve issues and resume the execution of running applications. | ||
| RIDE is a cross-platform, graphical development environment capable of producing a rich user experience. With it, you can use APL interactively to explore data, discover algorithms and create solutions – or diagnose problems, resolve issues and resume the execution of running applications. | ||
|
|
||
| The RIDE runs separately from the APL interpreter, and communicates with it using TCP/IP sockets. The RIDE can be run on macOS, Microsoft Windows and Linux (including the Raspberry Pi). In addition to being used as a front end for APL running locally, it can also be used to launch APL sessions on remote machines or to connect to APL interpreters that are already running – either locally or remotely. | ||
| RIDE runs separately from the APL interpreter, but can communicate with any local or remote APL session. It can launch APL sessions on remote machines or to connect to APL interpreters that are already running. | ||
|
|
||
| From Dyalog version 17.0, the interpreter can easily be configured to act as a web server which provides the RIDE application as a web page. This makes it possible to run the RIDE in a browser on any platform, without installing it locally. The RIDE needs to be installed on the machine where the interpreter is running, so the files can be provided as a webpage. Because no client-side installation is necessary, this mode is known as Zero Footprint. | ||
|
|
||
| The RIDE has two main modes of use: | ||
|
|
||
| - Providing a user interface to an interpreter engine (local or remote). | ||
|
|
||
| The RIDE is the recommended IDE for Dyalog on macOS or Linux (including the Raspberry Pi). In these environments, an application icon is provided to launch RIDE and an APL interpreter together. In this mode, the RIDE and the interpreter can be thought of as a single unit. Under Microsoft Windows, the native Dyalog IDE continues to provide the richest environment for the development of APL applications for Microsoft Windows users. | ||
|
|
||
| - As a tool for managing connections to a collection of interpreter sessions. | ||
|
|
||
| In this mode, the RIDE-Dyalog Session dialog box is used to launch or connect to one or more interpreters. | ||
|
|
||
| !!!note | ||
| Although the RIDE can manage multiple concurrent Dyalog Sessions, each Dyalog Session can only be connected to a single instance of the RIDE at any one time. | ||
| An interpreter can also provide RIDE's interface as a web page. This makes it possible to control a remote interpreter thorugh a browser, without installing RIDE on your machine. For this zero-footprint mode to work on Windows, RIDE needs to be installed on the machine where the interpreter is running, however, it comes with the interpreter installation on all other platforms. | ||
|
|
||
| On Windows, the interpreter has a built-in IDE, which continues to provide the richest environment, however, RIDE the recommended interface on all other platforms. |
Oops, something went wrong.