diff --git a/Home.md b/Home.md index 02d0bf3..53f0957 100644 --- a/Home.md +++ b/Home.md @@ -1,226 +1,5 @@ -### Cool-Retro-Term 1.1.1 (Stable Version) +Welcome to the cool-retro-term Wiki. Here you can find some useful information regarding: -      Cool-Retro-Term for Windows - -      Cool-Retro-Term for Mac - -      Cool-Retro-Term for Linux - - - - - - -|> Default Amber|C:\ IBM DOS|$ Default Green| -|---|---|---| -|![Default Amber Cool Retro Term](https://user-images.githubusercontent.com/121322/32070717-16708784-ba42-11e7-8572-a8fcc10d7f7d.gif)|![IBM DOS](https://user-images.githubusercontent.com/121322/32070716-16567e5c-ba42-11e7-9e64-ba96dfe9b64d.gif)|![Default Green Cool Retro Term](https://user-images.githubusercontent.com/121322/32070715-163a1c94-ba42-11e7-80bb-41fbf10fc634.gif)| - -## 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. - -This terminal emulator works under Linux and macOS and requires Qt 5.2 or higher. - -Settings such as colors, fonts, and effects can be accessed via context menu. - -## Screenshots -![Image]() -![Image]() -![Image]() - -## Install -Walk the easy way and install cool-retro-term using one of these convenient packages: - -Just grab the latest AppImage from the release page and make it executable and run it: - - wget https://github.com/Swordfish90/cool-retro-term/releases/download/1.1.1/Cool-Retro-Term-1.1.1-x86_64.AppImage - chmod a+x Cool-Retro-Term-1.1.1-x86_64.AppImage - ./Cool-Retro-Term-1.1.1-x86_64.AppImage - -**Fedora** has the `cool-retro-term` in the official repositories. All you have to do is `sudo dnf install cool-retro-term`. - -Users of **openSUSE** can grab a package from [Open Build Service](http://software.opensuse.org/package/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): - - trizen -S aur/cool-retro-term-git - -or use: - - pacman -S cool-retro-term - -to install precompiled from community repository. - -Users of **Ubuntu 14.04 LTS (Trusty) up to 15.10 (Wily)** can use [this PPA](https://launchpad.net/~bugs-launchpad-net-falkensweb). - -**Ubuntu 17.10** can use [this PPA](https://launchpad.net/%7Evantuz/+archive/ubuntu/cool-retro-term) - -**Solus** users can install using `eopg`: -``` -eopkg it cool-retro-term -``` - -**macOS** users can grab the latest dmg from the [release page](https://github.com/Swordfish90/cool-retro-term/releases) or install via Homebrew or MacPorts: -``` -brew install cool-retro-term --cask -``` -or -``` -port install cool-retro-term -``` - -**FreeBSD** users can install cool-retro-term with `pkg`: - - pkg install cool-retro-term - -## Build instructions (FreeBSD) - -Grab a copy of [the FreeBSD Ports Collection](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports-using.html), modify [`/usr/ports/x11/cool-retro-term/Makefile`](https://svnweb.freebsd.org/ports/head/x11/cool-retro-term/Makefile?view=markup) as you like, and then run `make install` to build and install the emulator: - -``` -cd /usr/ports/x11/cool-retro-term -make install -``` - -## Build instructions (Linux) - -Build cool-retro-term yourself, you know, the retro way. - -## Dependencies -Make sure to install these first. - ---- - -**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** - - 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 - ---- - -**Ubuntu 17.04** - - sudo apt install build-essential libqt5qml-graphicaleffects qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick-controls qml-module-qtquick-dialogs qmlscene qt5-default qt5-qmake qtdeclarative5-dev qtdeclarative5-localstorage-plugin qtdeclarative5-qtquick2-plugin qtdeclarative5-window-plugin - ---- - -**Ubuntu 17.10** - - sudo apt-get install build-essential qml-module-qtgraphicaleffects qml-module-qt-labs-folderlistmodel qml-module-qt-labs-settings qml-module-qtquick-controls qml-module-qtquick-dialogs qmlscene qt5-default qt5-qmake qtdeclarative5-dev qtdeclarative5-localstorage-plugin qtdeclarative5-qtquick2-plugin qtdeclarative5-window-plugin - ---- - -**snapcraft (most of distros)** - - sudo snap install cool-retro-term --classic - ---- - -**Debian Jessie and above** - - sudo apt 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 qml-module-qt-labs-settings qml-module-qt-labs-folderlistmodel - ---- - -**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 - -or: - - 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 - ---- - -**openSUSE** - -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 - -Install dependencies: - - sudo zypper install libqt5-qtbase-devel libqt5-qtdeclarative-devel libqt5-qtquickcontrols libqt5-qtgraphicaleffects - ---- - -**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: - -```bash -# Get it from GitHub -git clone --recursive https://github.com/Swordfish90/cool-retro-term.git - -# Build it -cd cool-retro-term - -# Compile (Fedora and OpenSUSE user should use qmake-qt5 instead of qmake) -qmake && make - -# Have fun! -./cool-retro-term -``` - -## Build instructions (macOS) - -1. Install [Xcode](https://developer.apple.com/xcode/) and agree to the licence agreement -2. Enter the following commands into the terminal: - -**Brew** - -```sh -brew install qt5 -git clone --recursive https://github.com/Swordfish90/cool-retro-term.git -export CPPFLAGS="-I/usr/local/opt/qt5/include" -export LDFLAGS="-L/usr/local/opt/qt5/lib" -export PATH=/usr/local/opt/qt5/bin:$PATH -cd cool-retro-term -qmake && make -mkdir cool-retro-term.app/Contents/PlugIns -cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns -open cool-retro-term.app -``` - -**MacPorts** - -```sh -sudo port install qt5 -git clone --recursive https://github.com/Swordfish90/cool-retro-term.git -cd cool-retro-term -/opt/local/libexec/qt5/bin/qmake && make -mkdir cool-retro-term.app/Contents/PlugIns -cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns -open cool-retro-term.app -``` - -**Homebrew** - -```sh -brew install cool-retro-term --cask -``` - -## 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. +* [Installing](https://github.com/Swordfish90/cool-retro-term/wiki/Install) +* [Building (Linux)](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(Linux)) +* [Building (macOS)](https://github.com/Swordfish90/cool-retro-term/wiki/Build-Instructions-(macOS)) \ No newline at end of file