Commit 0a75da43 authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

#19 Release notes updates for v0.1 + documentation improvements.

 - Updated/extended released notes for v0.1.
 - Removed '(unreleased)' annotations in release notes.
   - Difficult to keep up-to-date.
 - Added more documentation cross-linking (ESCET to/from languages).
   - Using actual online URLs, which are now known.
 - Cross-linking information extended with what you'll find there.
 - Refer to website for development information.
 - Our tools are also available as plug-ins from an update site.
 - Some other small textual changes in documentation.
parent 31b5ce06
Pipeline #82 running with stage
in 0 seconds
......@@ -7,7 +7,7 @@ Thanks for your interest in this project.
The Eclipse Supervisory Control Engineering Toolkit (Eclipse ESCET) project
provides a toolkit for the development of supervisory controllers. The toolkit
has a strong focus on industrial applicability, e.g. to cyber physical
has a strong focus on industrial applicability, e.g. to cyber-physical
systems. The toolkit includes tooling to support the entire development
process of (supervisory) controllers, including among others specification,
supervisory controller synthesis, simulation-based validation and
......@@ -22,9 +22,10 @@ For more information, see:
## Developer resources
For more information regarding source code management, builds, setting up a
developer environment, coding standards, how to contribute, and more, see:
developer environment, coding standards, how to contribute, and more, see
the Eclipse ESCET development documentation at:
* https://projects.eclipse.org/projects/technology.escet/developer
* https://eclipse.org/escet/escet/#developer-chapter-index
The project maintains the following source code repositories:
......
......@@ -31,8 +31,10 @@ It uses a process-based view, and uses synchronous point-to-point
communication between processes. A process is written as an imperative
program, with a syntax much inspired by the well-known Python language.
Chi is one of the tools of the
link:https://eclipse.org/escet[Eclipse ESCET(TM) project].
Chi is one of the tools of the Eclipse ESCET(TM) project. Visit the
link:https://eclipse.org/escet[project website] for downloads,
installation instructions, source code, general tool usage information,
information on how to contribute, and more.
[WARNING]
====
......
......@@ -21,6 +21,16 @@ The release notes for the releases of Chi and the associated tools, as
part of the Eclipse ESCET project, are listed below in reverse chronological
order.
=== Version 0.1 (unreleased)
See also the Eclipse ESCET
link:https://www.eclipse.org/escet/escet/#release-notes-chapter-index[toolkit release notes]
covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.1
The first release of Chi as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University
of Technology (TU/e).
Most notable changes:
- The Chi simulator no longer crashes on code generation.
......@@ -32,8 +32,10 @@ including among others specification, supervisory controller synthesis,
simulation-based validation and visualization, verification, real-time
testing, and code generation.
CIF is one of the tools of the
link:https://eclipse.org/escet[Eclipse ESCET(TM) project].
CIF is one of the tools of the Eclipse ESCET(TM) project. Visit the
link:https://eclipse.org/escet[project website] for downloads,
installation instructions, source code, general tool usage information,
information on how to contribute, and more.
[WARNING]
====
......
......@@ -21,6 +21,23 @@ The release notes for the releases of CIF and the associated tools, as
part of the Eclipse ESCET project, are listed below in reverse chronological
order.
=== Version 0.1 (unreleased)
See also the Eclipse ESCET
link:https://www.eclipse.org/escet/escet/#release-notes-chapter-index[toolkit release notes]
covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.1
The first release of CIF as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University
of Technology (TU/e).
Most notable changes:
- The names of the CIF command line tools and tools available in ToolDef
scripts have changed. For more information, check the list of
<<tools-scripting-chapter-tools,currently available tools>>.
- The CIF simulator no longer crashes on code generation.
- The CIF simulator plot visualizer has been re-implemented using different
third party libraries.
- All TU/e course material and course-related documentation has been removed.
- The experimental model-logic synthesis tool has been removed.
......@@ -21,7 +21,8 @@ ToolDef scripts. ToolDef is a
cross-platform and machine-independent scripting language that supports command
line execution, but is also available as plug-in for
link:https://eclipse.org[Eclipse], providing an integrated development
experience.
experience. See the link:https://eclipse.org/escet/tooldef[ToolDef website] for
more information on ToolDef.
=== Scenarios
......
......@@ -61,13 +61,16 @@ operating system.
experience with other JDK vendors may vary.
** A Java Runtime Environment (JRE) is not sufficient. A JDK is required.
The following documentation is available for download:
The tools are also available as plug-ins for the Eclipse IDE, by means of an
Eclipse P2 update site.
Furthermore, the following documentation is available for download:
* Eclipse ESCET documentation (this documentation)
* Chi documentation
* CIF documentation
* SeText documentation
* ToolDef documentation
* <<intro-chapter-chi,Chi>> documentation
* <<intro-chapter-cif,CIF>> documentation
* <<intro-chapter-setext,SeText>> documentation
* <<intro-chapter-tooldef,ToolDef>> documentation
The following additional information is available:
......
......@@ -25,11 +25,11 @@ include::_root_attributes.asciidoc[]
:title-logo-image: {imgsdir}/eclipse-incubation.png
The Eclipse Supervisory Control Engineering Toolkit (Eclipse ESCET(TM))
project is an link:https://eclipse.org[Eclipse] project that provides a
toolkit for the development of supervisory controllers in the Model-Based
Systems Engineering (MBSE) paradigm. The toolkit has a strong focus on
model-based design, supervisory controller synthesis, and industrial
applicability, for example to cyber physical systems. The toolkit supports
project is an link:https://eclipse.org[Eclipse Foundation] open-source project
that provides a toolkit for the development of supervisory controllers in the
Model-Based Systems Engineering (MBSE) paradigm. The toolkit has a strong
focus on model-based design, supervisory controller synthesis, and industrial
applicability, for example to cyber-physical systems. The toolkit supports
the entire development process of (supervisory) controllers, from modeling,
supervisory controller synthesis, simulation-based validation and
visualization, and formal verification, to real-time testing and
......
......@@ -59,12 +59,13 @@ of the product-items.
The Chi toolset allows verification of properties of the actual system by
means of simulation, e.g. to optimize the supervisory (logic) control of
the system. The Chi language has features that allow for easy
specification of . Chi aims to make the process of verifying properties for large
systems effortless.
specification of . Chi aims to make the process of verifying properties for
large systems effortless.
Tutorials and manuals demonstrate the use of the language for effective
modeling of system processes. More detailed modeling of the processes and
e.g performance indicators, or custom tailoring them to the real situation,
has no inherent limits.
See the separate Chi documentation for more information.
See the separate link:https://eclipse.org/escet/chi[Chi documentation] for more
information.
......@@ -54,4 +54,5 @@ visualization-based validation.
* Implementation language code generation (PLC languages, Java, C, and
Simulink) for real-time testing and implementation of the designed controller.
See the separate CIF documentation for more information.
See the separate link:https://eclipse.org/escet/cif[CIF documentation] for
more information.
......@@ -26,15 +26,15 @@ shown to lead to less defects and reduced costs.
indexterm:[MBSE]
The Eclipse Supervisory Control Engineering Toolkit (Eclipse ESCET) project is
an link:https://eclipse.org[Eclipse] project that provides a toolkit for the
development of supervisory controllers in the MBSE paradigm. The toolkit has
a strong focus on model-based design, supervisory controller synthesis, and
industrial applicability, for example to cyber physical systems. The toolkit
supports the entire development process of (supervisory) controllers, from
modeling, supervisory controller synthesis, simulation-based validation and
visualization, and formal verification, to real-time testing and
implementation.
The Eclipse Supervisory Control Engineering Toolkit (Eclipse ESCET(TM))
project is an link:https://eclipse.org[Eclipse Foundation] open-source project
that provides a toolkit for the development of supervisory controllers in the
MBSE paradigm. The toolkit has a strong focus on model-based design,
supervisory controller synthesis, and industrial applicability, for example to
cyber-physical systems. The toolkit supports the entire development process of
(supervisory) controllers, from modeling, supervisory controller synthesis,
simulation-based validation and visualization, and formal verification, to
real-time testing and implementation.
indexterm:[synthesis]
......
......@@ -25,4 +25,5 @@ SeText is used as scanner/parser technology for the other tools within the
Eclipse ESCET project. It is however a generic scanner/parser generator that can
also be used for the development of scanners and parsers for other languages.
See the separate SeText documentation for more information.
See the separate https://eclipse.org/escet/setext[SeText documentation] for more
information.
......@@ -32,4 +32,5 @@ generic scripting language, and can be used without using any of the other
Eclipse ESCET tools. Furthermore, other tools can be made available for use
within ToolDef scripts by defining ToolDef libraries for them.
See the separate ToolDef documentation for more information.
See the separate https://eclipse.org/escet/tooldef[ToolDef documentation] for
more information.
......@@ -21,6 +21,22 @@ The release notes for the releases of the Eclipse ESCET tools,
as part of the Eclipse ESCET project, are listed below in reverse
chronological order.
=== Version 0.1 (unreleased)
See also the release notes for the specific tools for more information:
- link:https://www.eclipse.org/escet/cif/#release-notes-chapter-index[CIF release notes]
- link:https://www.eclipse.org/escet/chi/#release-notes-chapter-index[Chi release notes]
- link:https://www.eclipse.org/escet/tooldef/#release-notes-chapter-index[ToolDef release notes]
- link:https://www.eclipse.org/escet/setext/#setext-readme-release-notes[SeText release notes]
=== Version 0.1
The first release of the Eclipse ESCET project and toolkit.
This release is based on the initial contribution by the Eindhoven University
of Technology (TU/e).
Most notable changes:
- A JDK is no longer bundled with the downloads. A JDK must be installed
separately and manually. Future releases will again include a JDK.
This release is based on the Eclipse IDE version 2020-06 and supports Java 8.
......@@ -28,8 +28,10 @@ SeText is a textual syntax specification language and associated scanner/parser
generator. It can be used to specify the syntax of a language, and automatically
generate a scanner and LALR(1) parser(s).
SeText is one of the tools of the
link:https://eclipse.org/escet[Eclipse ESCET(TM) project].
SeText is one of the tools of the Eclipse ESCET(TM) project. Visit the
link:https://eclipse.org/escet[project website] for downloads,
installation instructions, source code, general tool usage information,
information on how to contribute, and more.
[WARNING]
====
......@@ -669,9 +671,15 @@ The release notes for the releases of SeText and the associated tools, as
part of the Eclipse ESCET project, are listed below in reverse chronological
order.
=== Version 0.1 (unreleased)
See also the Eclipse ESCET
link:https://www.eclipse.org/escet/escet/#release-notes-chapter-index[toolkit release notes]
covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.1
The first release of SeText as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University
of Technology (TU/e). There should be no functional changes.
[[setext-readme-legal]]
......
......@@ -30,8 +30,10 @@ It supports command line execution, but is also available as plug-in for
the link:https://eclipse.org[Eclipse] IDE, providing an integrated development
experience.
ToolDef is one of the tools of the
link:https://eclipse.org/escet[Eclipse ESCET(TM) project].
ToolDef is one of the tools of the Eclipse ESCET(TM) project. Visit the
link:https://eclipse.org/escet[project website] for downloads,
installation instructions, source code, general tool usage information,
information on how to contribute, and more.
[WARNING]
====
......
......@@ -21,6 +21,16 @@ The release notes for the releases of ToolDef and the associated tools, as
part of the Eclipse ESCET project, are listed below in reverse chronological
order.
=== Version 0.1 (unreleased)
See also the Eclipse ESCET
link:https://www.eclipse.org/escet/escet/#release-notes-chapter-index[toolkit release notes]
covering those aspects that are common to the various Eclipse ESCET tools.
=== Version 0.1
The first release of ToolDef as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University
of Technology (TU/e).
Most notable changes:
- The `.tooldef2` file extension has been changed to `.tooldef`.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment