README.adoc

CodeReady Containers - OpenShift 4 on your Laptop

• Introduction
• Documentation
• Community

Introduction

This project is focused on bringing a minimal OpenShift 4.0 or newer cluster to your local laptop or desktop computer.

If you are looking for a solution for running OpenShift 3.x, you will need tools such as oc cluster up, Minishift or CDK.

Check back for updates, we plan to have something available "soon".

Documentation

Getting CodeReady Containers

CodeReady Containers binaries with an embedded OpenShift disk image can be downloaded from this page.

Using CodeReady Containers

The documentation for CodeReady Containers is currently hosted by GitHub Pages.

See the Red Hat CodeReady Containers Getting Started Guide.

Building the documentation

You can find the source files for the documentation in the docs/source directory.

To build the formatted documentation, install podman then use the following:

$ git clone https://github.com/code-ready/crc
$ cd crc
$ make build_docs

This will create a docs/build/master.html file which you can view in your browser.

Developing CodeReady Containers

Developers who want to work on CodeReady Containers should visit the Developing CodeReady Containers document.

Community

Contributions, questions, and comments are all welcomed and encouraged!

You can reach the community by:

• Joining the #codeready channel on Freenode IRC

If you want to contribute, make sure to follow the contribution guidelines when you open issues or submit pull requests.