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".
You can find the source files for the documentation in the docs/source directory.
To build the formatted documentation, 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.
Developers who want to work on CodeReady Containers should visit the Developing CodeReady Containers document.
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.