search

eclipse-openj9 / openj9-docs

Source repository for the Eclipse OpenJ9 user documentation, which should be viewed [online]https://www.eclipse.org/openj9/docs/
Other
51 stars 72 forks source link
hacktoberfest

readme

OpenJ9 logo

# Eclipse OpenJ9 user documentation [![Build Status](https://openj9-jenkins.osuosl.org/buildStatus/icon?job=Build-Doc-Push_to_Eclipse)](https://openj9-jenkins.osuosl.org/job/Build-Doc-Push_to_Eclipse) [![License](https://img.shields.io/badge/License-EPL%202.0-green.svg)](https://opensource.org/licenses/EPL-2.0) [![License](https://img.shields.io/badge/License-APL%202.0-green.svg)](https://opensource.org/licenses/Apache-2.0) This repository contains the source files for the [Eclipse OpenJ9 user documentation](http://www.eclipse.org/openj9/docs). The user documentation tells you how to configure, tune, and diagnose problems with an OpenJDK that has been built with the OpenJ9 Java virtual machine. New to Eclipse OpenJ9? Here are a few links to get you started: - Visit the [Eclipse OpenJ9 website](http://www.eclipse.org/openj9) to find out more. - Read the [Getting started](https://www.eclipse.org/openj9/docs/introduction/) topic in our user documentation. The files in this repository are authored in markdown format and built using [Mkdocs](http://www.mkdocs.org/) with the [MkDocs-material theme](https://squidfunk.github.io/mkdocs-material/). Draft documentation for the next release is hosted via the gh-pages branch of this repository at the following URL: https://eclipse-openj9.github.io/openj9-docs/). We welcome contributions to the user documentation. Please follow our [Contribution guidelines](CONTRIBUTING.md).