From 009f2dd9988320e60efb07a81e878e02c7a81a61 Mon Sep 17 00:00:00 2001 From: Filippo Scognamiglio Date: Fri, 11 Jul 2014 02:16:10 +0200 Subject: [PATCH] Improved README.md --- README.md | 38 +++++++++++++++++++++++++++++++------- app/app.qmlproject.user | 2 +- 2 files changed, 32 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3ec6009..100b3ed 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,39 @@ +#cool-old-term + +##Description cool-old-term is a terminal emulator which tries to mimic the look and feel of the old cathode tube screens. It has been designed to be eye-candy, customizable, and reasonably lightweight. -It now uses the konsole engine which is powerful and stable. +It now uses the konsole engine which is powerful and mature. -To build and launch it (Qt5.2 are required): +This terminal emulator requires Qt 5.2 or higher to run. + +##Screenshots +![Image]() +![Image]() +![Image]() + +##Build instruction +First of all we need to retrieve the dependencies. + +###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 + +###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.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: git clone https://github.com/Swordifish90/cool-old-term.git - cd cool-old-term - cd konsole-qml-plugin - qmake && make && make install - cd .. + cd cool-old-term + cd konsole-qml-plugin + qmake && make && make install + cd .. ./cool-old-term -This is still an eary release, but you are free to test it and tell me what do you think. diff --git a/app/app.qmlproject.user b/app/app.qmlproject.user index 15f913f..aad3915 100644 --- a/app/app.qmlproject.user +++ b/app/app.qmlproject.user @@ -1,6 +1,6 @@ - + ProjectExplorer.Project.ActiveTarget