diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40a81e0f..46894e23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ -# Contributing to Orbit SimRel Platform +# Contributing to Orbit SimRel -Thank you for your interest in this project. +Thank you for your interest in the project. Please read the Eclipse Platform Project's [General Instructions](https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md) for account setup and recommended workflows. ## Creating an Eclipse Development Environment -You can set up a pre-configured IDE for development of Obit SimRel using the following link. +You can set up a pre-configured IDE for development of Orbit SimRel using the following link. [![Create Eclipse Development Environment for the Eclipse SDK](https://download.eclipse.org/oomph/www/setups/svg/Orbit_SimRel.svg)](https://www.eclipse.org/setups/installer/?url=https://raw.githubusercontent.com/eclipse-orbit/orbit-simrel/main/OrbitSimRelConfiguration.setup&show=true "Click to open Eclipse-Installer Auto Launch or drag onto your running installer's title area") ## Contact -Contact the project developers via the project's ["dev" mailing list](https://dev.eclipse.org/mailman/listinfo/orbit-dev). +Contact the project developers via the repository's [discussions](https://github.com/eclipse-orbit/orbit-simrel/discussions) if you have questions, suggestions, or requests. diff --git a/README.md b/README.md index bb50a0ec..77d4dd79 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,41 @@ -# Orbit SimRel +# Eclipse Orbit SimRel +## Managing 3rd Party Dependencies -### Contributing +This repository provides infrastructure for managing 3rd party dependencies based libraries hosted at [Maven Central](https://repo1.maven.org/maven2/). +It augments the Eclipse Bundle Recipes [EBR](https://github.com/eclipse-orbit/ebr/#readme) infrastructure +transitionally used by [Orbit](https://github.com/eclipse-orbit/orbit/#readme). +Many libraries hosted at Maven central are already provided in the form of OSGi bundles and can simply be reused as is, +but many others need to be repackaged as bundles. +Orbit has traditionally been repackaging all libraries from Maven Central using EBR, which is based on [BND](https://bnd.bndtools.org/). -Contributions are always welcome! -See [CONTRIBUTING.md](CONTRIBUTING.md) +Eclipse [m2e](https://projects.eclipse.org/projects/technology.m2e) provides extensions to Eclipse [PDE](https://projects.eclipse.org/projects/eclipse.pde) +that allow dependencies on Maven artifacts to be expressed directly in a target platform file, +including the ability to wrap a non-OSGi jar as an OGI-bundle using BND instructions. +This mechanism is also directly support by [Tycho](https://projects.eclipse.org/projects/technology.tycho). + + +### Maven OSGi + +The `maven-osgi` folder provides infrastructure for analyzing, updating, and aggregating Maven dependencies in target platform files +and is used to produce a p2 update site hosting Maven libraries that are directly available as OSGi bundles. +The corresponding [readme](maven-osgi/README.md) provides details. + + +### Maven BND + +The `maven-bnd` folder provides infrastructure for wrapping non-OSGi Maven dependencies as OSGi bundles +and is used to produce a p2 update site hosting Maven libraries wrapped OSGi bundles. +The corresponding [readme](maven-bnd/README.md) provides details. + + +### Orbit Aggregation + +The `orbit-aggregation` folder provides infrastructure aggregating the results +The corresponding [readme](orbit-aggregation/README.md) provides details. + + +## Contributing + +Contributions are welcome. +See [CONTRIBUTING.md](CONTRIBUTING.md) for details. diff --git a/maven-bnd/README.md b/maven-bnd/README.md new file mode 100644 index 00000000..ac81bc07 --- /dev/null +++ b/maven-bnd/README.md @@ -0,0 +1 @@ +# Maven BND diff --git a/maven-osgi/README.md b/maven-osgi/README.md new file mode 100644 index 00000000..66ae0a30 --- /dev/null +++ b/maven-osgi/README.md @@ -0,0 +1 @@ +# Maven OSGi diff --git a/orbit-aggregation/README.md b/orbit-aggregation/README.md new file mode 100644 index 00000000..b2bc1e5a --- /dev/null +++ b/orbit-aggregation/README.md @@ -0,0 +1 @@ +# Orbit Aggregation diff --git a/report/README.md b/report/README.md new file mode 100644 index 00000000..1f28535f --- /dev/null +++ b/report/README.md @@ -0,0 +1 @@ +# Reports