diff --git a/README.md b/README.md index e3d021ad8..8d9297c23 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,52 @@ -# chatterino 2 +![alt text](https://fourtf.com/img/chatterino-icon-64.png) +Chatterino 2 +============ -Chatterino 2 is the second installment of the twitch chat client series "Chatterino". For now you can check out chatterino 1 at [chatterino.com](http://chatterino.com). +Chatterino 2 is the second installment of the Twitch chat client series "Chatterino". For now you can check out Chatterino 1 at [chatterino.com](chatterino.com). -## code style -The code is normally formated using clang format in qt creator. [.clang-format](https://github.com/fourtf/chatterino2/blob/master/.clang-format) contains the style file for clang format. +## Code style +The code is normally formated using clang format in Qt Creator. [.clang-format](https://github.com/fourtf/chatterino2/blob/master/.clang-format) contains the style file for clang format. -## requirements +## Building +Before building run `git submodule update --init --recursive` to get required submodules. -### submodules -you need to run `git submodule update --init --recursive` to init the submodules - -### windows -#### boost +### Windows +#### Using Qt Creator +##### boost download the [boost library](https://sourceforge.net/projects/boost/files/boost/1.63.0/boost_1_63_0.zip/download) and extract it to `C:\local\boost` -#### open-ssl +##### open-ssl 1. download binaries for OpenSSL >= 1.0.2 or compile it from source. [example download](https://indy.fulgan.com/SSL/) 2. Place libeay32.dll and ssleay32.dll from OpenSSL in a directory in PATH. -#### rapidjson +##### rapidjson 1. download rapidjson zip from https://github.com/miloyip/rapidjson/releases/latest 2. extract to `C:/local/rapidjson` so that `C:/local/rapidjson/include/rapidjson/` is a proper path -### linux +#### Using MSYS2 +Building using MSYS2 can be quite easier process. Check out MSYS2 at [msys2.org](http://www.msys2.org/). +1. open appropriate MSYS2 terminal and do `pacman -S mingw-w64--boost mingw-w64--qt5 mingw-w64--rapidjson` where is x86_64 or i686 +2. go into the project directory +3. create build folder `mkdir build && cd build` +4. `qmake .. && mingw32-make` + +### + +### Linux #### Ubuntu 16.04.2 LTS *most likely works the same for other Debian-like distros* -1. Install QT Creator `sudo apt-get install qtcreator qtmultimedia5-dev` -1. Install boost-dev `sudo apt-get install libboost-all-dev` -1. Copy `include/rapidjson` from [rapidjson](https://github.com/miloyip/rapidjson/releases/latest) into the chatterino directory so that the file `/rapidjson/document.h` exists -1. Open `chatterino.pro` with QT Creator and build +1. install QT Creator `sudo apt-get install qtcreator qtmultimedia5-dev` +2. install boost-dev `sudo apt-get install libboost-all-dev` +3. copy `include/rapidjson` from [rapidjson](https://github.com/miloyip/rapidjson/releases/latest) into the chatterino directory so that the file `/rapidjson/document.h` exists +4. open `chatterino.pro` with QT Creator and build + +#### Arch Linux +1. `sudo pacman -S qt5 boost rapidjson` +2. go into project directory +3. create build folder `mkdir build && cd build` +4. `qmake .. && make` ### Mac OSX -1. Install XCode and XCode Command Line Utilites -2. Install QT Creator -3. Install brew https://brew.sh/ +1. install Xcode and Xcode Command Line Utilites +2. install Qt Creator +3. install brew https://brew.sh/ 4. `brew install boost openssl rapidjson` -5. Build the garbage using QT creator -6. gachiGASM +5. build the project using Qt Creator