Contributing to the CE Toolchain

If you are brave enough to contribute source to the CE Toolchain, this page is for you!

Creating PRs for review

Pull Requests (PRs) should branch from git master. Before creating a PR, it may be a good idea to get some feedback from IRC/Discord first. This will increase the chances of your PR being merged in a timely fashion. Please do not make large PRs; it is better to make smaller changes in different PRs.

For information on how to fork a repo and create a PR using GitHub, see the forking documentation.

Building the CE Toolchain

Linux and macOS

Get the ez80 LLVM compiler. Make sure that ez80-clang and ez80-link are reachable by the system’s PATH environment variable.

Get the fasmg assembler. The download is located near the bottom of the page. Extract the fasmg.x64 executable to the same location as the compiler. Rename it to just fasmg.

Clone the repo:

git clone --recurse-submodules https://github.com/CE-Programming/toolchain.git

Build and install the toolchain:

cd toolchain
make -j
make install -j

By default, the toolchain is installed into the home (~/CEdev) directory.

This is configurable with make install PREFIX=[LOCATION]

Windows

Get MinGW. The only required pacakges are mingw32-base and mingw32-gcc-g++. Make sure the MinGW\\bin directory is in the system’s PATH environment variable.

Get the ez80 LLVM compiler. Make sure that ez80-clang.exe and ez80-link.exe are reachable by the system’s PATH environment variable.

Get the fasmg assembler. The download is located near the bottom of the page. Extract the fasmg.exe executable to the same location as the compiler.

Clone the repo:

git clone --recurse-submodules https://github.com/CE-Programming/toolchain.git

Build and install the toolchain:

cd toolchain
mingw32-make -j
mingw32-make install -j

By default, the toolchain is installed into the root (C:\\CEdev) directory.

This is configurable with mingw32-make install PREFIX=[LOCATION]