Skip to content

InstallationInstructions.md

Latest commit

 

History

History
81 lines (53 loc) · 3.86 KB

InstallationInstructions.md

File metadata and controls

81 lines (53 loc) · 3.86 KB

Please create installation instructions for this program, written as for a beginner at installing linux programs

Of course. Here is a set of installation instructions for the EGGSHELL program, written for someone who is new to Linux.

Welcome to EGGSHELL! A Beginner's Installation Guide

Welcome! This guide will walk you through installing the EGGSHELL desktop environment on your openSUSE Leap system. EGGSHELL is designed to give your computer the modern look and feel of Windows 11 while keeping the power and stability of Linux.

We've made the process as simple as possible with a single script that does most of the heavy lifting. Just follow the steps below.

Part 1: Preparing Your System (The "Before You Start" Checklist)

Before we can install EGGSHELL, we need to make sure your system has the necessary tools. Think of this like gathering your ingredients before you start cooking. You will only need to do this once.

  1. Open the Terminal: The terminal is a powerful tool that lets you give direct text commands to your computer. On openSUSE with the default desktop, you can find it in your application menu. Look for an app called Konsole.
  2. Install the Required Tools: Copy the entire command block below. Click the "Paste" button in Konsole (or press Ctrl+Shift+V) and then hit Enter. You will be asked for your password. This command uses zypper, openSUSE's built-in tool, to install everything EGGSHELL needs.
sudo zypper install git-core gcc-c++ cmake python3-pip python3-venv libQt6Core6 libQt6Gui6 libQt6Qml6 libQt6Quick6 libqt6-qtbase-devel

This command installs: * Compilers and Build Tools (gcc-c++, cmake): Needed to build the C++ part of the desktop. * Git (git-core): Used to download the project files. * Python Tools (python3-pip, python3-venv): Required to run the backend of the Elemental Genius app. * Qt 6 Libraries (the libQt6 packages): The graphics framework used to draw the desktop interface.

Part 2: Installing EGGSHELL

Now that your system is ready, you can install the program itself.

Step 1: Download the EGGSHELL Files First, we need to download the program files. In your open terminal, run the following command to copy the project to your Home folder.

# This command assumes you are in your home directory
git clone <URL_to_EGGSHELL_repository> EGGSHELL

(Note: As this is a custom project, you would replace <URL_to_EGGSHELL_repository> with the actual Git URL provided for the project.)

Step 2: Navigate to the Project Folder Once the download is complete, you need to move into the new directory you just created. Use the cd (Change Directory) command:

cd EGGSHELL

Step 3: Run the Installer Script This is the final and most important step. We've provided a script that automates the entire installation.

First, you need to make the script executable, which is like giving your computer permission to run it.

chmod +x setup_and_run.sh

Now, run the script!

./setup_and_run.sh

The script will now automatically:

  1. Set up a safe, isolated environment for the Python backend.
  2. Install the necessary Python packages.
  3. Build the C++ desktop application.
  4. Launch the EGGSHELL desktop.

You will see text scrolling in your terminal as it completes these steps. When it's finished, your new EGGSHELL desktop will appear!

How to Launch EGGSHELL in the Future

You don't need to run the installer every time. Once the setup is complete, you can launch EGGSHELL again at any time by:

  1. Opening a terminal (Konsole).
  2. Navigating to the project folder: cd EGGSHELL
  3. Running the compiled program directly: ./build/eggshell