Skip to content

Commit

Permalink
[doc] Update the README
Browse files Browse the repository at this point in the history
Signed-off-by: Pierre-Charles David <[email protected]>
  • Loading branch information
pcdavid committed Jan 14, 2025
1 parent d1d158e commit 6c589f5
Showing 1 changed file with 5 additions and 15 deletions.
20 changes: 5 additions & 15 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
= Eclipse Sirius EMF JSON

This project is part of http://www.eclipse.org/sirius[Eclipse Sirius].
This project is part of https://eclipse.dev/sirius[Eclipse Sirius].
It provides a JSON-based implementation of EMF resources which can be used as a drop-in replacement for the default XMI-based format.

Although it is part of Sirius, this new EMF resource type can actually be used by any EMF-based application as it does not depend on the rest of the Sirius platform (neither Sirius Desktop nor Sirius Web).

== Building

The build uses https://maven.apache.org/[Apache Maven] (version 3.6.3) and http://www.eclipse.org/tycho/[Tycho]. To launch a complete build, issue:
The build uses https://maven.apache.org/[Apache Maven] (version 3.9.8). To launch a complete build, issue:

[source,sh]
----
mvn clean package -f releng/org.eclipse.sirius.emfjson.releng/pom.xml
mvn -f org.eclipse.sirius.emfjson/pom.xml clean package
----

from the top-level directory.

WARNING: Note that you will need to use **Java 11** to run the build. Java 12 and later are currently not supported.

If you are behind a proxy, you may get Maven errors about `checkstyle.org` not being available. In this case you need to explicitly disable CheckStyle from the build:

[source,sh]
----
mvn clean package -f releng/org.eclipse.sirius.emfjson.releng/pom.xml -P\!checkstyle
----

The resulting update-site (p2 repository) can be found in `repositories/org.eclipse.sirius.emfjson.repository/target/repository`.
WARNING: Note that you will need to use **Java 17** or later to run the build.

== Usage

Expand All @@ -37,9 +28,8 @@ For example:
Resource.Factory.Registry.INSTANCE.getExtensionToFactoryMap().put("json", new JsonResourceFactoryImpl());
----

If you are running in the context of the Eclipse Platform, the `org.eclipse.sirius.emfjson.ide` plug-in does this automatically and also registers the corresponding `Content-Type`.
See https://github.com/eclipse-sirius/sirius-web/tree/master/packages/emf/backend/sirius-components-emf[the Sirius Web sources] for concrete usage examples.

See the `org.eclipse.sirius.emfjson.resource.JsonResource` for various options that can be used to control the serialisation/deserialisation process (e.g. whether to pretty-print the JSON).

== License

Expand Down

0 comments on commit 6c589f5

Please sign in to comment.