This repository contains the source code for the CML compiler.
Master
One of the following is required to install the CML compiler:
- Homebrew (on macOS - at https://brew.sh)
- Linuxbrew (on Linux - at http://linuxbrew.sh)
Please report an issue if you cannot get the CML compiler installed using Homebrew or Linuxbrew.
The only pre-requisite to run the CML compiler is Java 8.
The cml
command should just work after installation if Java 8 is available on the environment.
Please report an issue, otherwise.
$ brew tap cmlang/cml # To make the CML compiler packages available.
$ brew install cml-compiler # To install the latest release.
To read the release notes of a specific version, please go to: https://github.com/cmlang/cml-releases/tree/master/cml-compiler
Look for the files ending with '.zip.notes.md'. For example: cml-compiler-1.0.zip.notes.md
The release version format is YEAR.MONTH.DAY-CHANNEL, where:
- YEAR/MONTH/DAY: the year/month/day the version was released.
- CHANNEL: which channel the release was published in: -- gold: backward-compatible, high-quality releases; low-risk upgrade. -- alpha: development releases; no quality/compatibility guarantees; high-risk upgrade.
Either release channel may include bug fixes and new features.
Before you can install the CML compiler, please run:
$ brew tap cmlang/cml
After that, the CML compiler packages will be available to be installed.
To find the versions of the CML compiler available to install:
$ brew update # To fetch all available versions.
$ brew search cml-compiler # To list available versions.
To read the release notes of a specific version, please go to (look for the '.zip.notes.md' files): https://github.com/cmlang/cml-releases/tree/master/cml-compiler
If you'd like to always have the latest version of the CML compiler, regardless of the channel where it was released:
$ brew update # To fetch all available versions.
$ brew install cml-compiler
Later on, to upgrade to the latest version:
$ brew update # To fetch all available versions.
$ brew upgrade cml-compiler
You may get a new gold version (and thus backward-compatible/high-quality version), but you may also get an alpha release.
If you'd like to get the latest release of a specific channel:
$ brew update # To fetch all available versions.
$ brew install cml-compiler-CHANNEL # where CHANNEL = alpha or gold
Once you've installed it, you can upgrade to the latest release of the channel with:
$ brew update # To fetch all available versions.
$ brew upgrade cml-compiler-CHANNEL # where CHANNEL = alpha or gold
You can also get the release of a specific day:
$ brew update # To fetch all available versions.
$ brew install [email protected]
You can even get the latest release of a specific year:
$ brew update # To fetch all available versions.
$ brew install cml-compiler@YEAR
If you've installed the current year, you can upgrade to the latest release of the current year with:
$ brew update # To fetch all available versions.
$ brew upgrade cml-compiler@CURRENT_YEAR
For information on helping us to develop CML, go to: CONTRIBUTING.md