Skip to content

Commit

Permalink
Create documentation scaffolding
Browse files Browse the repository at this point in the history
  • Loading branch information
merks committed Jul 13, 2023
1 parent bdd8eea commit 297f2fa
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 8 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
42 changes: 38 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions maven-bnd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Maven BND
1 change: 1 addition & 0 deletions maven-osgi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Maven OSGi
1 change: 1 addition & 0 deletions orbit-aggregation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Orbit Aggregation
1 change: 1 addition & 0 deletions report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Reports

0 comments on commit 297f2fa

Please sign in to comment.