diff --git a/Build-Instructions-(Linux).md b/Build-Instructions-(Linux).md new file mode 100644 index 0000000..9408d4a --- /dev/null +++ b/Build-Instructions-(Linux).md @@ -0,0 +1,50 @@ +# Build Instructions (Linux) + +You can also build cool-retro-term from source. + +## Dependencies + +Let's start by grabbing the correct dependencies for the most popular distros: + +--- + + # Ubuntu, Debian Jessie and above + + sudo apt install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls2 qml-module-qtgraphicaleffects qml-module-qtquick-dialogs qml-module-qtquick-localstorage qml-module-qtquick-window2 qml-module-qt-labs-settings qml-module-qt-labs-folderlistmodel + + + # Fedora + + sudo dnf -y install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qtgraphicaleffects qt5-qtquickcontrols redhat-rpm-config + + + # Arch Linux + + sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects + +--- + +**Anyone else** + +Install Qt directly from here http://qt-project.org/downloads . Once done export them in you path (replace "_/opt/Qt5.12.x/Qt5.12.x/gcc_64/bin_" with your correct folder): + + export PATH=/opt/Qt5.12.x/Qt5.12.x/gcc_64/bin/:$PATH +--- + +## Compile + +Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application: + +```bash +# Get it from GitHub +git clone --recursive https://github.com/Swordfish90/cool-retro-term.git + +# Build it +cd cool-retro-term + +# Compile +qmake && make + +# Have fun! +./cool-retro-term +```