Merge pull request #560 from ayazhafiz/docs/homebrew

Add installation instructions using Homebrew

.gitignore

@@ -18,6 +18,7 @@
 *.pro.user.*
 *.moc
 moc_*.cpp
+moc_*.h
 qrc_*.cpp
 ui_*.h
 Makefile*

.travis.yml

@@ -0,0 +1,37 @@
+sudo: required
+dist: trusty
+language: c++
+
+install:
+  - sudo add-apt-repository -y ppa:beineri/opt-qt58-trusty
+  - sudo apt-get update -qq
+  - sudo apt-get -y install build-essential qt58declarative qt58graphicaleffects qt58quickcontrols libgl1-mesa-dev
+  - source /opt/qt*/bin/qt*-env.sh
+
+script:
+  - qmake CONFIG+=release PREFIX=/usr
+  - make -j$(nproc)
+  - mkdir -p appdir/usr/share/metainfo appdir/usr/bin
+  - cp packaging/appdata/cool-retro-term.appdata.xml appdir/usr/share/metainfo/
+  - cp cool-retro-term appdir/usr/bin/
+  - cp ./cool-retro-term.desktop appdir/
+  - cp ./app/icons/128x128/cool-retro-term.png appdir/
+  - cp -r ./app/qml appdir/usr/
+  - cp -r ./qmltermwidget/QMLTermWidget appdir/usr/qml/ # Workaround for https://github.com/probonopd/linuxdeployqt/issues/78
+  - wget -c https://github.com/probonopd/linuxdeployqt/releases/download/continuous/linuxdeployqt-continuous-x86_64.AppImage
+  - chmod a+x linuxdeployqt-*.AppImage 
+  - unset QTDIR; unset QT_PLUGIN_PATH ; unset LD_LIBRARY_PATH
+  - export VERSION=$(git rev-parse --short HEAD) # linuxdeployqt uses this for naming the file
+  - ./linuxdeployqt-*.AppImage appdir/usr/bin/cool-retro-term -qmldir=./app/qml/ -qmldir=./qmltermwidget/ # -verbose=3 2>&1 | grep "path:" -C 3
+  - ./linuxdeployqt-*.AppImage appdir/usr/bin/cool-retro-term -qmldir=./app/qml/ -qmldir=./qmltermwidget/ -verbose=2 -appimage
+  
+after_success:
+  - find appdir -executable -type f -exec ldd {} \; | grep " => /usr" | cut -d " " -f 2-3 | sort | uniq
+  - # curl --upload-file Cool*.AppImage https://transfer.sh/Cool_Retro_Term-git.$(git rev-parse --short HEAD)-x86_64.AppImage
+  - wget -c https://github.com/probonopd/uploadtool/raw/master/upload.sh
+  - bash upload.sh Cool*.AppImage*
+  
+branches:
+  except:
+    - # Do not build tags that we create when we upload to GitHub Releases
+    - /^(?i:continuous)/

README.md

@@ -12,6 +12,8 @@ It uses the QML port of qtermwidget (Konsole) developed by me: https://github.co
 
 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](<https://i.imgur.com/TNumkDn.png>)
 ![Image](<https://i.imgur.com/hfjWOM4.png>)
@@ -20,13 +22,19 @@ This terminal emulator works under Linux and macOS and requires Qt 5.2 or higher
 ## Install
 Walk the easy way and install cool-retro-term using one of these convenient packages:
 
-**Fedora** has the `cool-retro-term` in the offcial repositories. All you have to do is `sudo dnf install cool-retro-term`.
+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):
 
-    yaourt -S aur/cool-retro-term-git
+    trizen -S aur/cool-retro-term-git
 
 or use:
 
@@ -34,22 +42,32 @@ or use:
 
 to install precompiled from community repository.
 
-**Gentoo** users can now install the third release "1.1.0" from a 3rd-party repository preferably via layman:
-
-    USE="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 before 27/08/17 should remove, update and add it again as its source has changed
-    ACCEPT_KEYWORDS="~*" emerge =x11-terms/cool-retro-term-1.1.0::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!
-
 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)
 
-**macOS** users can grab the latest dmg from the release page: https://github.com/Swordfish90/cool-retro-term/releases
+**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:
+```
+brew cask 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)
 
@@ -84,6 +102,12 @@ Make sure to install these first.
 
 ---
 
+**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
@@ -175,6 +199,12 @@ cp -r qmltermwidget/QMLTermWidget cool-retro-term.app/Contents/PlugIns
 open cool-retro-term.app
 ```
 
+**Homebrew**
+
+```sh
+brew cask install cool-retro-term
+```
+
 ## 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).
 

app/main.cpp

@@ -33,11 +33,37 @@ int main(int argc, char *argv[])
     // This disables QT appmenu under Ubuntu, which is not working with QML apps.
     setenv("QT_QPA_PLATFORMTHEME", "", 1);
 
+#if defined (Q_OS_LINUX)
+    setenv("QSG_RENDER_LOOP", "threaded", 0);
+#endif
+
 #if defined(Q_OS_MAC)
     // This allows UTF-8 characters usage in OSX.
     setenv("LC_CTYPE", "UTF-8", 1);
 #endif
 
+    if (argc>1 && (!strcmp(argv[1],"-h") || !strcmp(argv[1],"--help"))) {
+        QTextStream cout(stdout, QIODevice::WriteOnly);
+        cout << "Usage: " << argv[0] << " [--default-settings] [--workdir <dir>] [--program <prog>] [-p|--profile <prof>] [--fullscreen] [-h|--help]" << endl;
+        cout << "  --default-settings  Run cool-retro-term with the default settings" << endl;
+        cout << "  --workdir <dir>     Change working directory to 'dir'" << endl;
+        cout << "  -e <cmd>            Command to execute. This option will catch all following arguments, so use it as the last option." << endl;
+        cout << "  -T <title>          Set window title to 'title'." << endl;
+        cout << "  --fullscreen        Run cool-retro-term in fullscreen." << endl;
+        cout << "  -p|--profile <prof> Run cool-retro-term with the given profile." << endl;
+        cout << "  -h|--help           Print this help." << endl;
+        cout << "  --verbose           Print additional information such as profiles and settings." << endl;
+        return 0;
+    }
+
+    QString appVersion("1.1.1");
+
+    if (argc>1 && (!strcmp(argv[1],"-v") || !strcmp(argv[1],"--version"))) {
+        QTextStream cout(stdout, QIODevice::WriteOnly);
+        cout << "cool-retro-term " << appVersion << endl;
+	return 0;
+    }
+
     QApplication app(argc, argv);
     // set application attributes
     // Has no effects, see https://bugreports.qt.io/browse/QTBUG-51293
@@ -55,25 +81,6 @@ int main(int argc, char *argv[])
 
     // Manage command line arguments from the cpp side
     QStringList args = app.arguments();
-    if (args.contains("-h") || args.contains("--help")) {
-        // BUG: This usage help text goes to stderr, should go to stdout.
-        // BUG: First line of output is surrounded by double quotes.
-        qDebug() << "Usage: " + args.at(0) + " [--default-settings] [--workdir <dir>] [--program <prog>] [-p|--profile <prof>] [--fullscreen] [-h|--help]";
-        qDebug() << "  --default-settings  Run cool-retro-term with the default settings";
-        qDebug() << "  --workdir <dir>     Change working directory to 'dir'";
-        qDebug() << "  -e <cmd>            Command to execute. This option will catch all following arguments, so use it as the last option.";
-        qDebug() << "  -T <title>          Set window title to 'title'.";
-        qDebug() << "  --fullscreen        Run cool-retro-term in fullscreen.";
-        qDebug() << "  -p|--profile <prof> Run cool-retro-term with the given profile.";
-        qDebug() << "  -h|--help           Print this help.";
-        qDebug() << "  --verbose           Print additional information such as profiles and settings.";
-        return 0;
-    }
-
-    if (args.contains("-v") || args.contains("--version")) {
-        qDebug() << "cool-retro-term 1.0.1";
-	return 0;
-    }
 
     // Manage default command
     QStringList cmdList;
@@ -82,6 +89,7 @@ int main(int argc, char *argv[])
     }
     QVariant command(cmdList.empty() ? QVariant() : cmdList[0]);
     QVariant commandArgs(cmdList.size() <= 1 ? QVariant() : QVariant(cmdList.mid(1)));
+    engine.rootContext()->setContextProperty("appVersion", appVersion);
     engine.rootContext()->setContextProperty("defaultCmd", command);
     engine.rootContext()->setContextProperty("defaultCmdArgs", commandArgs);
 

app/qml/ApplicationSettings.qml

@@ -24,7 +24,7 @@ import QtQuick.Controls 1.0
 import "utils.js" as Utils
 
 QtObject{
-    readonly property string version: "1.1.0"
+    readonly property string version: appVersion
     readonly property int profileVersion: 2
 
     // STATIC CONSTANTS ////////////////////////////////////////////////////////
@@ -59,6 +59,8 @@ QtObject{
     property real burnInQuality: 0.5
     property bool useFastBurnIn: Qt.platform.os === "osx" ? false : true
 
+    property bool blinkingCursor: false
+
     onWindowScalingChanged: handleFontChanged();
 
     // PROFILE SETTINGS ///////////////////////////////////////////////////////
@@ -134,7 +136,7 @@ QtObject{
 
     property FontLoader fontLoader: FontLoader { }
 
-    onFontScalingChanged: handleFontChanged();
+    onTotalFontScalingChanged: handleFontChanged();
     onFontWidthChanged: handleFontChanged();
 
     function getIndexByName(name) {
@@ -208,7 +210,8 @@ QtObject{
             burnInQuality: burnInQuality,
             useCustomCommand: useCustomCommand,
             customCommand: customCommand,
-            useFastBurnIn: useFastBurnIn
+            useFastBurnIn: useFastBurnIn,
+            blinkingCursor: blinkingCursor
         }
         return stringify(settings);
     }
@@ -296,6 +299,8 @@ QtObject{
         customCommand = settings.customCommand !== undefined ? settings.customCommand : customCommand
 
         useFastBurnIn = settings.useFastBurnIn !== undefined ? settings.useFastBurnIn : useFastBurnIn;
+
+        blinkingCursor = settings.blinkingCursor !== undefined ? settings.blinkingCursor : blinkingCursor
     }
 
     function loadProfileString(profileString){

app/qml/Fonts.qml

@@ -236,7 +236,9 @@ QtObject{
     function addSystemFonts() {
         var families = monospaceSystemFonts;
         for (var i = 0; i < families.length; i++) {
-            console.log("Adding system font: ", families[i])
+            if (verbose) {
+                console.log("Adding system font: ", families[i])
+            }
             fontlist.append(convertToListElement(families[i]))
         }
     }

app/qml/PreprocessedTerminal.qml

@@ -94,6 +94,7 @@ Item{
         smooth: !appSettings.lowResolutionFont
         enableBold: false
         fullCursorHeight: true
+        blinkingCursor: appSettings.blinkingCursor
 
         session: QMLTermSession {
             id: ksession

app/qml/SettingsTerminalTab.qml

@@ -114,6 +114,24 @@ Tab{
                 }
             }
         }
+        GroupBox{
+            title: qsTr("Cursor")
+            Layout.fillWidth: true
+            ColumnLayout {
+                anchors.fill: parent
+                CheckBox{
+                    id: blinkingCursor
+                    text: qsTr("Blinking Cursor")
+                    checked: appSettings.blinkingCursor
+                    onCheckedChanged: appSettings.blinkingCursor = checked
+                }
+                Binding{
+                    target: blinkingCursor
+                    property: "checked"
+                    value: appSettings.blinkingCursor
+                }
+            }
+        }
         GroupBox{
             title: qsTr("Colors")
             Layout.fillWidth: true

snap/snapcraft.yaml

@@ -1,39 +1,53 @@
 name: cool-retro-term # check to see if it's available
-version: '1.1.0' # this is freakin' awesome
+version: '1.1.1' # this is freakin' awesome
-summary: cool-retro-term is a terminal emulator. # 79 char long summary
+summary: cool-retro-term is a cool and retro terminal emulator. # 79 char long summary
 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.
 grade: stable # must be 'stable' to release into candidate/stable channels
-confinement: strict # use 'strict' once you have the right plugs
+confinement: classic # use 'strict' once you have the right plugs
+
+base: core18
 
 apps:
   cool-retro-term:
-    command: desktop-launch $SNAP/usr/bin/cool-retro-term
+    command: bin/desktop-launch $SNAP/usr/bin/cool-retro-term
     desktop: usr/share/applications/cool-retro-term.desktop
-    plugs:
+    environment:
-      - unity7
+      QML2_IMPORT_PATH: $SNAP/usr/lib/x86_64-linux-gnu/qt5/qml
-      - x11
-      - desktop
-      - home
-      - network
-      - network-bind
-      - network-manager
-      - password-manager-service
-      - locale-control
-      - gsettings
-      - shutdown
-      - firewall-control
-      - process-control
-      - system-observe
       
 parts:
+  desktop-qt5:
+    source: https://github.com/ubuntu/snapcraft-desktop-helpers.git
+    source-subdir: qt
+    plugin: make
+    make-parameters: ["FLAVOR=qt5"]
+    build-packages:
+      - build-essential
+      - qtbase5-dev
+      - dpkg-dev
+    stage-packages:
+      - libxkbcommon0
+      - ttf-ubuntu-font-family
+      - dmz-cursor-theme
+      - light-themes
+      - adwaita-icon-theme
+      - gnome-themes-standard
+      - shared-mime-info
+      - libqt5gui5
+      - libgdk-pixbuf2.0-0
+      - libqt5svg5 # for loading icon themes which are svg
+      - try: [appmenu-qt5] # not available on core18
+      - locales-all
+      - xdg-user-dirs
+      - fcitx-frontend-qt5
+
   my-part:
     source: https://github.com/Swordfish90/cool-retro-term
     source-type: git
     plugin: qmake # See 'snapcraft plugins'
     qt-version: qt5
     after: [desktop-qt5]
-    
+
     build-packages:
       - build-essential 
       - qmlscene 
@@ -44,11 +58,14 @@ parts:
     stage-packages: 
       - qmlscene
       - qml-module-qtquick-controls 
-      - qtdeclarative5-qtquick2-plugin 
+      - qml-module-qtquick2
-      - libqt5qml-graphicaleffects 
+      - qml-module-qtgraphicaleffects
       - qml-module-qtquick-dialogs 
-      - qtdeclarative5-localstorage-plugin 
+      - qml-module-qtquick-localstorage
-      - qtdeclarative5-window-plugin
+      - qml-module-qtquick-window2
       - libgl1-mesa-dev
       - qtdeclarative5-dev-tools
       - qml-module-qtquick-extras
+      - qml-module-qt-labs-settings
+      - qml-module-qt-labs-folderlistmodel
+