Skip to content

Latest commit

 

History

History
103 lines (70 loc) · 4.02 KB

README.md

File metadata and controls

103 lines (70 loc) · 4.02 KB
Raw

CodeCTRL

Formatting Clippy Build & Packaging Auto-update Build Containers

Implementing a logger for a language

By default, these are the officially supported loggers:

Language Link
Rust Here
Go Here
C++ Here
Python Here
PHP Here
NodeJS Here

All language loggers now need to use gRPC in order to implement the API schema. The protobuf files are available here.

Unofficial language loggers:

  • None yet (remove me if/when one is added).

Build requirements

Below you will find the requirements to build on each platform. The supported platform(s) are:

  • Linux - Supported: Ubuntu 23.04, Ubuntu 22.04, Ubuntu 20.04, Fedora 38, Fedora Rawhide, Debian 11, Debian 10 and Debian Sid.
  • Windows
  • MacOS - Supported: 13, 12, 11 (Intel and Apple Silicon).

Planned support:

Packages for the supported distributions listed above can be found here underneath each of the completed CI jobs.

Linux

The current officially supported Linux distributions are the following:

NOTE: You can use the ./bootstrap-build.sh or the ./bootstrap-action.sh scripts to automatically install the dependencies for the supported distributions.

Support is planned for the following:

  • Arch (and it's derivatives)

Fedora and RHEL

Minimum supported Fedora version: 38.

You will need to install the "Development Tools" group. You can do this by running: sudo dnf groupinstall "Development Tools" -y.

Build dependencies

Aside from the Cargo toolchain, you will need:

  • freetype-devel
  • expat-devel
  • fontconfig-devel
  • cmake
  • A C++ compiler, most likely g++ or clang

Debian-based

There is support for Ubuntu 23.04, Ubuntu 22.04, Ubuntu 20.04, Debian 11, Debian 10 and Debian Sid.

Build dependencies

Aside from the Cargo toolchain, you will need:

  • build-essential
  • libfreetype-dev
  • libfontconfig-dev
  • cmake
  • A C++ compiler, most likely g++ or clang

Windows and MacOS

You can build CodeCTRL for Windows and MacOS simply by installing rustup via the normal channel: here, and issuing a cargo build --release at the root of this project.

MSIs for Windows is automatically generated on every commit of the CodeCTRL main branch and can be found in one of the completed workflow runs here.

Similarly, there are generated MacOS app packages on every commit on the CodeCTRL main branch and can be found on the same link above.