Loading...

Projects

theShell

theShell

Down at its core, it's up for anything.

And it's easy to download too.

But first,

Here are some things you might need to know.

Let's do it!

Which branch of theShell do you want to use?

theShell Stable

Recommended for most users

theShell Blueprint

Recommended for the early testers

You can install both next to each other!

Get theShell Stable

theShell Stable is the branch of theShell where everything has been tested and should be stable enough for daily use.


Arch Linux

Binary packages can be retrieved from the theSuite repository. This also has the advantage of easier updating with pacman.

  1. Add the theSuite repository to your system.
    Edit /etc/pacman.conf and add the following at the bottom:
    [theapps]
    SigLevel = Optional TrustAll
    Server = https://vicr123.github.io/repo/arch/$arch/
  2. Force an update of the system and all repositores pacman -Syyu
  3. Install theShell pacman -S theshell

If you'd like to use the AUR instead, install the theshell package from the Arch User Repository.
Use of an AUR helper is recommended as there are a lot of dependencies to install.


Ubuntu 18.04

Binary packages can be retrieved from the theSuite repository. This also has the advantage of easier updating with apt.

theShell on Ubuntu is currently beta quality, and some things may not work properly. Please report a bug if you have any issues using theShell on Ubuntu.
You'll need to have a 64-bit installation of Ubuntu to install theShell using the repository.
  1. Add signing keys to your system wget -O - https://vicr123.com/repo/apt/vicr12345.gpg.key | apt-key add -
    You'll need to run a root shell before this step. Using sudo will not work.
  2. Add the theSuite repository to your system.
    add-apt-repository 'deb https://vicr123.com/repo/apt/ubuntu bionic main'
  3. Force an update of system repositories apt update
  4. Install KWin without installing its recommended dependencies apt install --no-install-recommends kwin-x11
    If you don't perform this step before you install theShell, apt may try to install KDE Plasma as well as theShell.
  5. Install theShell apt install theshell

Build from source

If theShell is not packaged for your distribution, you can build theShell from source yourself.

  1. Install dependencies of theShell.
    Dependency Information
  2. Download the sources of theShell. git clone https://github.com/vicr123/theshell cd theshell
  3. Build theShell qmake theShell.pro make
  4. Install theShell make install
    If you're installing theShell to a different root directory, you can use the INSTALL_ROOT environment variable to set the path for theShell.

Get theShell Blueprint

theShell Blueprint is the branch of theShell where breaking changes may happen at any time. However, you get to test the newest features of theShell. It's recommended that you do not use theShell Blueprint as your daily driver.


Arch Linux

Install the theshell-blueprint package from the Arch User Repository.
Use of an AUR helper is recommended as there are a lot of dependencies to install.


Build from source

If theShell is not packaged for your distribution, you can build theShell from source yourself.

  1. Install dependencies of theShell.
    Dependency Information
  2. Download the sources of theShell Blueprint. git clone https://github.com/vicr123/theshell#branch=blueprint cd theshell
  3. Build theShell in Blueprint mode qmake "CONFIG+=blueprint" theShell.pro make
  4. Install theShell Blueprint make install
    If you're installing theShell to a different root directory, you can use the INSTALL_ROOT environment variable to set the path for theShell.

Dependency Information

theShell relies on some dependencies to work properly. Here is a list of dependencies you'll need to install to build and run theShell.

As package names can vary between distributions, package names are not provided here. You'll need to do some research to find the correct package for your distribution.

  • Qt 5, including
    • Networking module
    • Charts module
    • Location module
  • An EWMH Compatible Window Manager (by default KWin is installed)
  • wmctrl
  • xbacklight
  • kscreen
  • NetworkManager
  • pulseaudio
  • systemd
  • Xlib
  • xcb
  • the-libs
  • tsscreenlock
  • ts-qtplatform

theShell OS

For the perfect experience with theShell

Learn More

Any issues?

If you think you've found a bug, I'd appreciate it if you'd report it on the GitHub Issues page. Thanks!

GitHub Issues