Mirroristas/cool-retro-term
2
0
Fork 0
mirror of https://github.com/Swordfish90/cool-retro-term.git synced 2025-11-24 14:35:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Restyle markdown

Browse Source 
Most of these changes are centered around changing the styling so
GitHub will render the file better. There were also some spelling
and grammar fixes, plus a couple of minor language improvements.

I also added a table of contents for easy access to different sections
though it's already laid out in a good order.
This commit is contained in:
Jade Thornton 2017-03-21 23:08:37 -05:00
parent e48719fa44
commit eab8cdb788
1 changed files with 153 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

228
README.md
View File

@ -1,117 +1,178 @@
#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.
It uses the QML port of qtermwidget (Konsole) developed by me: https://github.com/Swordfish90/qmltermwidget . 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.
This terminal emulator works under Linux and OSX and requires Qt 5.2 or higher. It uses the QML port of qtermwidget (Konsole) developed by me:
<https://github.com/Swordfish90/qmltermwidget>.
##Screenshots This terminal emulator works on Linux and OSX and requires Qt 5.2 or higher.
![Image](<http://i.imgur.com/I6wq1cC.png>)
![Image](<http://i.imgur.com/12EqlpL.png>)
![Image](<http://i.imgur.com/Lx0acQz.jpg>)
##Get cool-retro-term ### Contents
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). * [Screenshots](#screenshots)
* [Install](#install-cool-retro-term)
Arch users can install this [package](https://aur.archlinux.org/packages/cool-retro-term-git/) directly via the [AUR](https://aur.archlinux.org): * [From package manager or PPA](#install-cool-retro-term)
* [From source (Linux)](#build-from-source-on-linux)
yaourt -S aur/cool-retro-term-git * [Dependencies](#install-dependencies-first)
* [Compile](#then-compile)
or use: * [From source (OSX)](#build-from-source-on-osx)
* [Donate](#donations)
pacman -S cool-retro-term
to install precompiled from community repository.
Gentoo users can now install the first release "1.0" from a 3rd-party repository preferably via layman:
USE="subversion git" emerge app-portage/layman
wget https://www.gerczei.eu/files/gerczei.xml -O /etc/layman/overlays/gerczei.xml
layman -f -a qt -a gerczei # those who've added the repo already should sync instead via 'layman -s gerczei'
ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.0.0-r1::gerczei
The live ebuild (version 9999-r1) tracking the bleeding-edge WIP codebase also remains available.
A word of warning: USE flags and keywords are to be added to portage's configuration files and every emerge operation should be executed with '-p' (short option for --pretend) appended to the command line first as per best practice!
Ubuntu users of 14.04 LTS (Trusty) up to 15.10 (Wily) can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb)
OSX users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases
##Build instructions (Linux)
##Dependencies
Make sure to install these first.
--- ---
**Ubuntu 14.04** ## Screenshots
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 ![cool-retro-term preview](<http://i.imgur.com/I6wq1cC.png>)
![preview of a man page (for gcc)](<http://i.imgur.com/12EqlpL.png>)
![preview of midnight commander](<http://i.imgur.com/Lx0acQz.jpg>)
--- ---
**Ubuntu 16.10** ## Install Cool-Retro-Term
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 #### Arch
Install [this package](https://aur.archlinux.org/packages/cool-retro-term-git/) directly via the [AUR](https://aur.archlinux.org):
```
yaourt -S aur/cool-retro-term-git
```
or install the precompiled package:
```
pacman -S cool-retro-term
```
#### Fedora and openSUSE
Grab the package from [Open Build Service](http://software.opensuse.org/package/cool-retro-term).
#### Gentoo
Gentoo users can now install the first release "1.0" from a 3rd-party
repository preferably via layman:
```
USE="subversion git" emerge app-portage/layman
wget https://www.gerczei.eu/files/gerczei.xml -O /etc/layman/overlays/gerczei.xml
layman -f -a qt -a gerczei # those who've added the repo already should sync instead via 'layman -s gerczei'
ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.0.0-r1::gerczei
```
The live ebuild (version 9999-r1) tracking the bleeding-edge WIP codebase also
remains available.
A word of warning: USE flags and keywords are to be added to portage's
configuration files and every emerge operation should be executed with `-p`
(short option for `--pretend`) appended to the command line first as per best
practice!
#### Ubuntu 14.04 LTS (Trusty) through 15.10 (Wily)
Use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb)
#### OSX
Get the latest dmg from the release page: <https://github.com/Swordfish90/cool-retro-term/releases>
--- ---
**Debian Jessie** ## Build from source on Linux
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 ### Install dependencies first
--- ---
**Fedora** #### Ubuntu 14.04
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 ```
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
```
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
```
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
```
sudo yum -y install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qtgraphicaleffects qt5-qtquickcontrols redhat-rpm-config
```
or: or:
sudo dnf -y install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qtgraphicaleffects qt5-qtquickcontrols redhat-rpm-config ```
sudo dnf -y install qt5-qtbase qt5-qtbase-devel qt5-qtdeclarative qt5-qtdeclarative-devel qt5-qtgraphicaleffects qt5-qtquickcontrols redhat-rpm-config
```
--- ---
**Arch Linux** #### Arch
```
sudo pacman -S qt5-base qt5-declarative qt5-quickcontrols qt5-graphicaleffects
```
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): Add repository with latest Qt 5 (this is only needed on openSUSE 13.1, Factory
already has it):
sudo zypper ar http://download.opensuse.org/repositories/KDE:/Qt5/openSUSE_13.1/ KDE:Qt5 ```
sudo zypper ar http://download.opensuse.org/repositories/KDE:/Qt5/openSUSE_13.1/ KDE:Qt5
```
Install dependencies: Install dependencies:
sudo zypper install libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtquickcontrols libqt5-qtgraphicaleffects ```
sudo zypper install libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtquickcontrols libqt5-qtgraphicaleffects
```
--- ---
**Anyone else** #### Anyone else
Install Qt directly from <http://qt-project.org/downloads>, then add it to your
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
```
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 ### Then compile
Once you installed all dependencies (Qt is installed and in your path) you need to compile and run the application:
```bash Once you installed all dependencies (Qt is installed and in your path) you need
to compile and run the application:
```sh
# Get it from GitHub # Get it from GitHub
git clone --recursive https://github.com/Swordfish90/cool-retro-term.git git clone --recursive https://github.com/Swordfish90/cool-retro-term.git
# Build it
cd cool-retro-term cd cool-retro-term
# Compile (Fedora and OpenSUSE user should use qmake-qt5 instead of qmake) # Compile (Fedora and OpenSUSE user should use qmake-qt5 instead of qmake)
@ -121,39 +182,56 @@ qmake && make
./cool-retro-term ./cool-retro-term
``` ```
##Build instructions (OSX) ---
## Build from source on OSX
1. Install [Xcode](https://developer.apple.com/xcode/) and agree to the licence agreement 1. Install [Xcode](https://developer.apple.com/xcode/) and agree to the licence agreement
2. Enter the following commands into the terminal: 2. Install using Brew or MacPorts:
**Brew** #### Brew
```sh ```sh
brew install qt5 brew install qt5
git clone --recursive https://github.com/Swordfish90/cool-retro-term.git git clone --recursive https://github.com/Swordfish90/cool-retro-term.git
export CPPFLAGS="-I/usr/local/opt/qt5/include" export CPPFLAGS="-I/usr/local/opt/qt5/include"
export LDFLAGS="-L/usr/local/opt/qt5/lib" export LDFLAGS="-L/usr/local/opt/qt5/lib"
export PATH=/usr/local/opt/qt5/bin:$PATH export PATH=/usr/local/opt/qt5/bin:$PATH
cd cool-retro-term cd cool-retro-term
qmake && make qmake && make
mkdir cool-retro-term.app/Contents/PlugIns mkdir cool-retro-term.app/Contents/PlugIns
cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns
open cool-retro-term.app open cool-retro-term.app
``` ```
**MacPorts** #### MacPorts
```sh ```sh
sudo port install qt5 sudo port install qt5
git clone --recursive https://github.com/Swordfish90/cool-retro-term.git git clone --recursive https://github.com/Swordfish90/cool-retro-term.git
cd cool-retro-term cd cool-retro-term
/opt/local/libexec/qt5/bin/qmake && make /opt/local/libexec/qt5/bin/qmake && make
mkdir cool-retro-term.app/Contents/PlugIns mkdir cool-retro-term.app/Contents/PlugIns
cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns
open cool-retro-term.app 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&currency_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) . I made this project in my spare time because I love what I'm doing. If you are
enjoying it, why not [buy me a beer](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=flscogna%40gmail%2ecom&lc=IT&item_name=Filippo%20Scognamiglio&currency_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. You can also add "bounties" on your favourite issues. More information on the
[Bountysource](https://www.bountysource.com/teams/crt/issues) page.