Stopeight
=========

Instructions have been tested on Ubuntu 22.04 Focal Fossa.

Installation
------------

Minimal Requirements (main repository)::

    $ sudo apt-get install git build-essential python3-dev python3-venv cmake

To run the editor, legacy tests and install to a separate environment (universe repository)::

    $ sudo apt-get install qtbase5-dev

The stopeight repository contains stopeight-clibs (Github)::

    $ git clone --recurse-submodules https://github.com/specpose/stopeight.git
    $ cd /path/to/where/stopeight
    $ git submodule init
    $ git submodule update

Build and install stopeight-clibs. (Alternative: Uncomment stopeight-clibs in CMakeLists.txt)::

    $ cd stopeight-clibs
    $ mkdir build
    $ cd build
    $ cmake ../
    $ make
    $ sudo make install
    $ sudo ldconfig
    $ cd ../../

Create a virtual environment::

    $ python3 -m venv ~/stopeight-test
    $ source ~/stopeight-test/bin/activate
    
Get the wheels. These eggs may be broken::

    $ python -m pip install setuptools PyQt5
    
And finally::

    $ python setup.py develop

Try the editor for a start. PyQt5 may segfault when running from inside a snap or an IDE-bound shell::

    $ python -m stopeight.util.editor.dispatch

Uninstall from another shell::

    $ ~/stopeight-test/bin/python setup.py develop --uninstall
    $ rm -R ~/stopeight-test
    $ rm -Rf /path/to/where/stopeight
    $ rm -R ~/.stopeight