b23b583cb3
githubs .md is different hence the change |
||
---|---|---|
dependencies | ||
docs | ||
forms | ||
lib | ||
resources | ||
src | ||
.clang-format | ||
.gitignore | ||
.gitmodules | ||
.travis.yml | ||
chatterino.pro | ||
ISSUE_TEMPLATE.md | ||
LICENSE | ||
README.md |
Chatterino 2
Chatterino 2 is the second installment of the Twitch chat client series "Chatterino". For now you can check out Chatterino 1 at https://chatterino.com.
Code style
The code is normally formated using clang format in Qt Creator. .clang-format contains the style file for clang format.
To setup automatic code formating with QT Creator, see this guide.
Building
Before building run git submodule update --init --recursive
to get required submodules.
Windows
Using Qt Creator
Visual Studio 2017
Install Visual Studio 2017 and select "Desktop development with C++" and "Universal Windows Platform development.
download the boost library and extract it to C:\local\boost
open-ssl
- download binaries for OpenSSL >= 1.0.2 or compile it from source. example download
- Place libeay32.dll and ssleay32.dll from OpenSSL in a directory in PATH.
Using MSYS2
Building using MSYS2 can be quite easier process. Check out MSYS2 at msys2.org. Be sure to add "-j <number of threads>" as a make argument so it will use all your cpu cores to build. example setup You can also add "-o2" to optimize the final binary size but increase compilation time, and add "-pipe" to use more ram in compilation but increase compilation speed
- open appropriate MSYS2 terminal and do
pacman -S mingw-w64-<arch>-boost mingw-w64-<arch>-qt5 mingw-w64-<arch>-rapidjson
where<arch>
is x86_64 or i686 - go into the project directory
- create build folder
mkdir build && cd build
qmake .. && mingw32-make
Linux
Ubuntu 16.04.2 LTS
most likely works the same for other Debian-like distros
- install QT Creator
sudo apt-get install qtcreator qtmultimedia5-dev
- install boost-dev
sudo apt-get install libboost-dev
- copy
include/rapidjson
from rapidjson into the chatterino directory so that the file<chatterino2 directory>/rapidjson/document.h
exists - open
chatterino.pro
with QT Creator and build
Ubuntu 18.04
most likely works the same for other Debian-like distros
- Install dependencies (and the C++ IDE Qt Creator)
sudo apt install qtcreator qtmultimedia5-dev libqt5svg5-dev libboost-dev
- Install rapidjson to
/usr/local/
like this: From the Chatterino2 root folder:sudo cp -r lib/rapidjson/include/rapidjson /usr/local/include
. If you want to install it to another place, you have to make sure it's in the chatterino.pro include path - open
chatterino.pro
with QT Creator and build
Arch Linux
install chatterino2-git from the aur or build manually as follows:
sudo pacman -S qt5-base qt5-multimedia gst-plugins-ugly gst-plugins-good boost rapidjson
- go into project directory
- create build folder
mkdir build && cd build
qmake .. && make
Mac OSX
- install Xcode and Xcode Command Line Utilites
- install Qt Creator
- install brew https://brew.sh/
brew install boost openssl rapidjson
- build the project using Qt Creator