https://github.com/eclipse/elk

Eclipse Layout Kernel - Automatic layout for Java applications.
https://github.com/eclipse/elk

eclipse java layout-algorithms

Last synced: 3 months ago
JSON representation

Eclipse Layout Kernel - Automatic layout for Java applications.

• Host: GitHub
• URL: https://github.com/eclipse/elk
• Owner: eclipse
• License: other
• Created: 2015-10-19T17:25:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-17T07:17:39.000Z (4 months ago)
• Last Synced: 2024-10-19T09:59:28.600Z (4 months ago)
• Topics: eclipse, java, layout-algorithms
• Language: Java
• Homepage: https://www.eclipse.org/elk/
• Size: 22 MB
• Stars: 250
• Watchers: 12
• Forks: 83
• Open Issues: 131
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-opensource-hardware - elk

README

        


   



Diagrams and visual languages are a great thing,

but getting the layout just right for them to be easily understandable

can be tedious and time-consuming.

The Eclipse Layout Kernel provides a number of layout algorithms

as well as an Eclipse-based infrastructure to connect them

to editors and viewers.

The layout algorithms are plain Java

and can thus also be used outside of Eclipse.

## More Info

* [The ELK homepage](http://www.eclipse.org/elk)

* [... and ELK's documentation](http://www.eclipse.org/elk/documentation.html)

* [ELK Live](https://rtsys.informatik.uni-kiel.de/elklive/) (web-based playground to play around with ELK)

* [elkjs](https://github.com/kieler/elkjs) (JavaScript library transpiled from ELK's Java sources)

## Example Layout

![](https://raw.githubusercontent.com/eclipse/elk/master/docs/static/img/example_layout_complexRouter.svg?sanitize=true)

## Repository Structure

The repository's structure is pretty straightforward. We only have a few folders:

* `build`:

  Contains all the files necessary to build ELK in all its different forms.

* `config`:

  Contains configuration files, such as our Checkstyle configuration.

* `docs`:

  Contains documentation in the form of a [Hugo](https://gohugo.io/) site.

* `features`:

  Contains all the Eclipse features ELK consists of.

* `plugins`:

  Contains all the plugins ELK consists of.

* `setups`:

  Contains our Oomph setup files.

* `tests`:

  Contains unit tests. Note that we have [a whole repository](https://github.com/eclipse/elk-models/) dedicated to test models.

## Building ELK

Information on how to build ELK and the documentation can be found [on our website](https://www.eclipse.org/elk/documentation/contributors/buildingelk.html).