Skip to content

Home

Jump to bottom
Chris Dedman Rollet edited this page Feb 28, 2025 · 16 revisions

Introduction

Welcome to the CodeAstra wiki!

This wiki is designed for old and new contributors and CodeAstra developers, who wish to learn everything necessary to easily install and contribute to CodeAstra.

Installation Guide

⚠️ CodeAstra officially support MacOS only. Although it should work on Windows, it could have unexpected behavior or errors. Consequentially, this guide has been constructed around MacOS.

For Mac Users

The installation on macOS is quite straightforward. Follow these steps:

  1. Clone the repository:

    git clone https://github.com/sandbox-science/CodeAstra.git

  2. Change into the project directory:

    cd CodeAstra

  3. Run make to install all necessary dependencies and build the software:

    make

  4. Run the following in your terminal to open the app:

    open CodeAstra.app

You will also be prompted if you want to create a Desktop Shortcut. If you enter y or Y, you will have a shortcut on your computer Desktop.

This will compile the software and install everything you need to get started.

For Windows Users (Recommended: Use WSL)

The software was not tested on Windows directly, but you can use Windows Subsystem for Linux (WSL) to install and run the software on Windows. Follow these steps:

Step 1: Install WSL

  1. Open PowerShell as Administrator and run the following command to install WSL (Ubuntu):

    wsl --install

  2. Restart your computer when prompted.

Step 2: Install Required Packages on WSL

Once you have WSL installed and running, follow these steps to install the necessary packages:

  1. Update the package list:

    sudo apt update

  2. Install make:

    sudo apt install make

  3. Install cmake:

    sudo apt install cmake

  4. Install the C++ compiler (g++):

    sudo apt install g++ -y

  5. Install essential build tools and dependencies:

    sudo apt-get install build-essential libgl1-mesa-dev

  6. Install Qt development libraries:

    sudo apt install qt6-base-dev

Step 3: Clone the Repository and Build the Software

After installing the required packages, you can now clone the repository and build the software:

  1. Clone the repository:

    git clone https://github.com/sandbox-science/CodeAstra.git

  2. Change into the project directory:

    cd CodeAstra

  3. Run make to build and install the software:

    make

This will compile the software inside WSL, and you should be able to use it as you would on a native Linux system.

Clone this wiki locally