From fbd8ddf2d33cede1dcca77be8aa1e1742f214c23 Mon Sep 17 00:00:00 2001 From: Alexandre Dantas Date: Thu, 31 Jul 2014 09:01:46 -0300 Subject: [PATCH 1/2] Change the appearance of `README` It makes sure not to keep much of a visual strain on specific distro instructions --- README.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 06d52b9..cf4a8e5 100644 --- a/README.md +++ b/README.md @@ -13,34 +13,47 @@ This terminal emulator requires Qt 5.2 or higher to run. ![Image]() ![Image]() -##Build instruction -First of all we need to retrieve the dependencies. +##Build instructions + +##Dependencies +Make sure to install these first. + +--- + +**Ubuntu 14.04** -###Ubuntu 14.04 sudo apt-get install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qtdeclarative5-controls-plugin qtdeclarative5-qtquick2-plugin libqt5qml-graphicaleffects qtdeclarative5-dialogs-plugin qtdeclarative5-localstorage-plugin qtdeclarative5-window-plugin -###Debian Jessie +--- + +**Debian Jessie** + sudo apt-get install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls qml-module-qtgraphicaleffects qml-module-qtquick-dialogs qml-module-qtquick-localstorage qml-module-qtquick-window2 -###Arch Linux +--- + +**Arch Linux** + sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects You can also install this [package](https://aur.archlinux.org/packages/cool-old-term-git/) directly via the [AUR](https://aur.archlinux.org): yaourt -S aur/cool-old-term-git -###Anyone else +--- + +**Anyone else** + Install Qt directly from here http://qt-project.org/downloads . Once done export them in you path (replace "_/opt/Qt5.3.1/5.3/gcc_64/bin_" with your correct folder): export PATH=/opt/Qt5.3.1/5.3/gcc_64/bin/:$PATH ###Compile -Once Qt are installed and in your path you need to compile and run the application: +Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application: - git clone https://github.com/Swordifish90/cool-old-term.git + git clone https://github.com/Swordifish90/cool-old-term.git cd cool-old-term cd konsole-qml-plugin qmake && make && make install cd .. - ./cool-old-term - + ./cool-old-term From 807e63c5be37595629d82521f022f3842f0f3ede Mon Sep 17 00:00:00 2001 From: Alexandre Dantas Date: Thu, 31 Jul 2014 09:05:28 -0300 Subject: [PATCH 2/2] Small change on `README` Made sure to separate the different phases of the building process. Also, added bash syntax highlighting to the build block. --- README.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cf4a8e5..8e12529 100644 --- a/README.md +++ b/README.md @@ -51,9 +51,16 @@ Install Qt directly from here http://qt-project.org/downloads . Once done export ###Compile Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application: - git clone https://github.com/Swordifish90/cool-old-term.git - cd cool-old-term - cd konsole-qml-plugin - qmake && make && make install - cd .. - ./cool-old-term +```bash +# Get it from GitHub +git clone https://github.com/Swordifish90/cool-old-term.git + +# Build it +cd cool-old-term +cd konsole-qml-plugin +qmake && make && make install +cd .. + +# Have fun! +./cool-old-term +```