Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 1.04 KB

install.md

File metadata and controls

53 lines (40 loc) · 1.04 KB
Raw

Install

Windows 🪟

Prerequisites (Need to install manually)

  • rustc
  • Cargo
  • rustup

Run this command to build the executable and run it

git clone https://github.com/AMS003010/Singularity.git
cd Singularity
cargo r -r

Linux 🐧

This was tested on a Ubuntu 24.04 LTS

Run these commands. This script installs everything for you including the prerequisites. install-linux.sh will install the prerequisites, build the exectable and add it to path (cargo's path).

git clone https://github.com/AMS003010/Singularity.git
cd Singularity/scripts/
chmod +x install-linux.sh
mv install-linux.sh ../
cd ..
./install-linux.sh

Now open a new terminal under the root of the singularity directory and run the executable, type

singularity

Run it as container 📦

Prerequisites

  • docker
git clone https://github.com/AMS003010/Singularity.git
cd Singularity
docker compose up

Caution

The project is under active development, expect things to break every once in a while 😑.