| Table of Contents |
|---|
| Platform-agnostic Requirements |
| Getting the Code |
| Building with Cargo |
| Automated CI Builds |
Platform-agnostic Requirements
You will need the following things, regardless of your platform of choice:
- Rust installed (MSRV is 1.62) - recommended via rustup.
- An OpenGL-capable device - specific versions unknown as the OpenGL bindings being used don’t specify supported versions. But to be safe, OpenGL 3.1+ devices should be compatible. This does mean that the appropriate graphics drivers will need to be installed for CodeCTRL to be able to run.
- Some basic knowledge of
git, either through the command line or a GUI front-end OR how to download.zips of code from GitHub.
Getting the Code
As mentioned in the Platform-agnostic Requirements, you will need some basic knowledge of Git, OR the know-how to download compressed archive versions of code off of GitHub.
Execute the following command in your terminal/command prompt:
git clone https://github.com/Authentura/codectrl
OR
Click here to download an archive of the latest codebase and unzip with an application of your choice.
Then, navigate to that directory and follow the appropriate instructions for your platform:
Building with Cargo
Assuming you have all the required dependencies for your platform of choice, you can now issue the following command in your command prompt/terminal.
cargo run --release
Automated CI Builds
The CodeCTRL GitHub repository automatically creates builds on select platforms automatically. This is useful if you want to have a bleeding-edge version of CodeCTRL without having to build it for yourself.
The currently generated packages are for the following platforms:
- Ubuntu 22.04 and 20.04
- Debian 11, 10 and Sid
- Fedora 36 and Rawhide
- RHEL (and compatibles) 7, 8 and 9
- Windows 7, 8(.1), 10 and 11
You can access the nightly builds here.
If you wish for more platforms to get automated CI builds, feel free to create an issue asking for that platform’s support or submit a PR if you believe you can implement it yourself.