Installation

Get the project

You have two options :

• Download the project from Github (zip format)

• Clone the project in a terminal

Download the project

You can click on "Code", then on "Download ZIP".

Clone the project

Before proceeding with the following commands, move to the location where you want skirnir to be installed.

Execute this command in a terminal

git clone https://github.com/Hyldem0er/Skirnir.git

Move to the project directory :

cd /path/to/the/project/Skirnir

Easiest Installation

Linux

For the most straightforward approach you can run the installation script with the following command : chmod +x launcher-linux.sh & sh launcher-linux.sh

Windows

If you plan to use Skirnir in wsl, you will need gedit to show the UI :

wsl -d [DISTRIBUTION] sudo apt-get install gedit -y

For the most straightforward approach, right click on launcher-win.bat and open it with administrator rights.

Advanced Installation

Prerequisites

• Python3 (with venv & pip)

• For Debian distribution : Install libgl1-mesa-glx

Getting Started

1. Create a python environment

python3 -m venv env

2. Activate the python environment

Linux/MacOS :

source env/bin/activate

Windows :

.\env\Scripts\activate

3. Install requirements

pip install -r requirements.txt

4. Launch the Skirnir program (User Interface)

Linux/MacOS :

python3 main.py --ui

Windows :

.\env\Scripts\python.exe main.py --ui