Skip to content

Commit 2c2977c

Browse files
committed
docs: update LyoD installation instructions
Signed-off-by: Andrew Berezovskyi <andriib@kth.se>
1 parent a54e289 commit 2c2977c

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed
Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,38 @@
11
# Installing Lyo Designer
22

3-
## Overall steps
3+
## Installing from a ready-built package (recommended)
44

55
1. Make sure you have Java 17 installed on your platform.
6-
1. Download the Lyo Designer application for your target operating system from [Lyo download site](https://download.eclipse.org/lyo/product/binaries/stable/)
6+
1. Download the Lyo Designer application for your target operating system from
7+
the [stable](https://download.eclipse.org/lyo/product/binaries/stable/)
8+
track (recommended) or
9+
[development](https://download.eclipse.org/lyo/product/binaries/edge/) track
10+
(normally, at your risk, unless instructed by the dev team).
711
1. Unzip your download to any desired application.
812
1. Run the `lyodesigner` executable.
9-
1. Regularly try to update the application by selecting ***help\--\>Check for Updates***
13+
1. Regularly try to update the application by selecting ***Help → Check for
14+
Updates***
1015

1116
## Installing as plugins on an Eclipse installation
12-
You can also install Lyo Designer as a set of plugins into an existing Eclipse installation.
13-
This is recommended for advanced users that can deal with conflicts in plugin dependencies when installing multiple plugins.
1417

15-
The Modelling environment and code generator are known to work on Eclipse
16-
versions up until Eclipse 2020-09 (v4.18).
18+
You can also install Lyo Designer as a set of plugins into an existing Eclipse
19+
installation. This is recommended for advanced users that can deal with
20+
conflicts in plugin dependencies when installing multiple plugins.
1721

18-
The easiest way to install Lyo Designer is via the update-site
19-
`http://download.eclipse.org/lyo/p2/stable/` (This URL is intended to
20-
be accessed via the Eclipse update functionality, and not via a web
21-
browser.)
22+
Prerequisites: the Modelling environment and code generator are known to work on Eclipse
23+
versions up until Eclipse 2022-03.
2224

23-
1. First make sure your Eclipse environment is setup
24-
as expected for general Lyo-based development, as instructed in [Eclipse Setup for Lyo-based Development](./eclipse-setup-for-lyo-based-development.md)
25-
1. Select ***Help \--\> Install New Software\...***
25+
Installation steps:
26+
27+
1. First make sure your Eclipse environment is setup as expected for general
28+
Lyo-based development, as instructed in [Eclipse Setup for Lyo-based
29+
Development](./eclipse-setup-for-lyo-based-development.md)
30+
1. Select ***Help → Install New Software...***
2631
1. Set ***Work With:*** to the update site
27-
<http://download.eclipse.org/lyo/p2/stable/>
28-
1. Select both features (1) ***Lyo Code Generator*** and (2) ***Lyo
29-
Toolchain Designer***.
32+
1. Use `http://download.eclipse.org/lyo/p2/stable/` for the stable build (recommended)
33+
1. Use `https://download.eclipse.org/lyo/product/p2/edge` for the latest unreleased build (use at your risk!)
34+
1. Select both features (1) ***Lyo Code Generator*** and (2) ***Lyo Toolchain
35+
Designer***.
3036
1. Proceed with the installation steps.
3137
1. Install the following plugins
3238
* Acceleo
@@ -35,27 +41,33 @@ as expected for general Lyo-based development, as instructed in [Eclipse Setup f
3541
* Sirius Properties Views - Specifier Support
3642
* Sirius Specifier Environment
3743

38-
**Problems installing?**: If you face problems installing the plugin
39-
(or when updating to a new version), try one of the following:
44+
!!! question "Problems installing?"
45+
If you face problems installing the plugin (or when
46+
updating to a new version), try one of the following:
4047

41-
1. Check the \"Contact all update sites during install to find
42-
required software\" option.
43-
2. Check/uncheck "Group items by category" (particularly the case,
44-
if you get the message "there are no categorized items").
45-
3. Uninstall existing version and then re-install the plugin again.
48+
1. Check the "Contact all update sites during install to find required
49+
software" option.
50+
2. Check/uncheck "Group items by category" (particularly the case, if you get
51+
the message "there are no categorized items").
52+
3. Uninstall existing version and then re-install the plugin again.
4653

47-
# Bleeding edge
54+
## Switching to development track plugins at a later point
4855

4956
**USE AT YOUR RISK**
5057

51-
You can configure the Lyo Designer application to get updates from yet-unreleased builds of Lyo Designer.
58+
You can configure the Lyo Designer application to get updates from
59+
yet-unreleased builds of Lyo Designer.
5260

53-
1. Select ***Window\--\>Preferences***
54-
1. Select ***Install/Update\--\>Available Software Sites***
55-
1. Either enable or create a new site with the location <https://download.eclipse.org/lyo/product/p2/edge>
61+
1. Select ***Window → Preferences***
62+
1. Select ***Install/Update → Available Software Sites***
63+
1. Either enable or create a new site with the location
64+
<https://download.eclipse.org/lyo/product/p2/edge>
5665
1. Click ***Apply and Close***.
57-
1. Update the application by selecting ***help\--\>Check for Updates***
66+
1. Update the application by selecting ***helpCheck for Updates***
5867

59-
## Lyo Designer Plugins
68+
## Running from source
6069

61-
For Lyo Designer installed as plugins, you can specify the update site <http://download.eclipse.org/lyo/p2/edge/>.
70+
If you wish to alter the source code of Lyo Designer (e.g., to contribute new
71+
features) or the generator templates (to update the structure of the generated
72+
code), you will need to [run Lyo Designer from
73+
source](https://github.com/eclipse/lyo.designer/wiki/Working-from-Source-Code).

0 commit comments

Comments
 (0)