diff --git a/README.md b/README.md index 72a0eed..c41a822 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -#cool-retro-term +# cool-retro-term + +## Description -##Description cool-retro-term is a terminal emulator which mimics the look and feel of the old cathode tube screens. It has been designed to be eye-candy, customizable, and reasonably lightweight. @@ -8,12 +9,14 @@ It uses the QML port of qtermwidget (Konsole) developed by me: https://github.co This terminal emulator works under Linux and OSX and requires Qt 5.2 or higher. -##Screenshots +## Screenshots + ![Image]() ![Image]() ![Image]() -##Get cool-retro-term +## Get cool-retro-term + You can either build cool-retro-term yourself (see below) or walk the easy way and install one of these packages: Users of Fedora and openSUSE can grab a package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term). @@ -43,32 +46,34 @@ Ubuntu users of 14.04 LTS (Trusty) up to 15.10 (Wily) can use [this PPA](https:/ OSX users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases -##Build instructions (Linux) +## Build instructions (Linux) + +## Dependencies -##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 --- -**Ubuntu 16.10** +#### Ubuntu 16.10 sudo apt-get install build-essential qmlscene qt5-qmake qt5-default qtdeclarative5-dev qml-module-qtquick-controls qtdeclarative5-qtquick2-plugin libqt5qml-graphicaleffects qml-module-qtquick-dialogs 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 --- -**Fedora** +#### Fedora + This command should install the known fedora dependencies: sudo yum -y install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qtgraphicaleffects qt5-qtquickcontrols redhat-rpm-config @@ -79,13 +84,13 @@ or: --- -**Arch Linux** +#### Arch Linux sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects - + --- -**openSUSE** +#### openSUSE Add repository with latest Qt 5 (this is only needed on openSUSE 13.1, Factory already has it): @@ -97,15 +102,16 @@ Install dependencies: --- -**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 you installed all dependencies (Qt is installed and in your path) you need to compile and run the application: +### 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 @@ -121,12 +127,12 @@ qmake && make ./cool-retro-term ``` -##Build instructions (OSX) +## Build instructions (OSX) 1. Install [Xcode](https://developer.apple.com/xcode/) and agree to the licence agreement 2. Enter the following commands into the terminal: -**Brew** +#### Brew ```sh brew install qt5 @@ -141,7 +147,7 @@ cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns open cool-retro-term.app ``` -**MacPorts** +#### MacPorts ```sh sudo port install qt5 @@ -153,7 +159,8 @@ cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns open cool-retro-term.app ``` -##Donations +## Donations + I made this project in my spare time because I love what I'm doing. If you are enjoying it and you want to buy me a beer click [here](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) . You can also add "bounties" on your favourite issues. More information on the [Bountysource](https://www.bountysource.com/teams/crt/issues) page.