noury/mirror-chatterino2
1
0
Fork 0
mirror of https://github.com/Chatterino/chatterino2.git synced 2024-11-13 19:49:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

Make README nicer (#120)

Browse source 
A bit of redesign of README file.

I think it should be clearly stated that Qt Creator is NOT a requirement for building this project. Someone should check whether Ubuntu and Mac Homebrew have Qt 5 packages WITHOUT Qt Creator (which I am certain they do).
This commit is contained in:
Matija 2017-09-28 22:24:14 +02:00 committed by fourtf
parent cb8846c0ae
commit 369b7c052b
1 changed files with 37 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
README.md
View file

@ -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 ## 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. 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 ### Windows
you need to run `git submodule update --init --recursive` to init the submodules #### Using Qt Creator
##### boost
### windows
#### 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` 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/) 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. 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 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 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-<arch>-boost mingw-w64-<arch>-qt5 mingw-w64-<arch>-rapidjson` where <arch> 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 #### Ubuntu 16.04.2 LTS
*most likely works the same for other Debian-like distros* *most likely works the same for other Debian-like distros*
1. Install QT Creator `sudo apt-get install qtcreator qtmultimedia5-dev` 1. install QT Creator `sudo apt-get install qtcreator qtmultimedia5-dev`
1. Install boost-dev `sudo apt-get install libboost-all-dev` 2. 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 `<chatterino2 directory>/rapidjson/document.h` exists 3. copy `include/rapidjson` from [rapidjson](https://github.com/miloyip/rapidjson/releases/latest) into the chatterino directory so that the file `<chatterino2 directory>/rapidjson/document.h` exists
1. Open `chatterino.pro` with QT Creator and build 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 ### Mac OSX
1. Install XCode and XCode Command Line Utilites 1. install Xcode and Xcode Command Line Utilites
2. Install QT Creator 2. install Qt Creator
3. Install brew https://brew.sh/ 3. install brew https://brew.sh/
4. `brew install boost openssl rapidjson` 4. `brew install boost openssl rapidjson`
5. Build the garbage using QT creator 5. build the project using Qt Creator
6. gachiGASM