2017-09-28 22:24:14 +02:00
Chatterino 2
============
2017-01-22 22:59:21 +01:00
2017-12-19 03:26:07 +01:00
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 ](https://chatterino.com ).
2017-02-06 14:47:47 +01:00
2017-09-28 22:24:14 +02:00
## Building
2018-01-23 14:51:54 +01:00
Before building run `git submodule update --init --recursive` to get required submodules.
2017-06-06 11:25:16 +02:00
2018-05-25 17:19:02 +02:00
[Building on Windows ](../master/BUILDING_ON_WINDOWS.md )
[Building on Linux ](../master/BUILDING_ON_LINUX.md )
[Building on Mac ](../master/BUILDING_ON_MAC.md )
2017-09-28 22:24:14 +02:00
2018-05-25 17:08:09 +02:00
## Code style
2018-05-25 17:19:02 +02:00
The code is 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.
2018-05-14 13:04:15 +02:00
2018-05-25 17:08:09 +02:00
To setup automatic code formating with QT Creator, see [this guide ](https://gist.github.com/pajlada/0296454198eb8f8789fd6fe7ea660c5b ).
2018-04-16 14:54:55 +02:00
2018-05-25 17:19:02 +02:00
### Get it automated with QT Creator + Beautifier + Clang Format
1. Download LLVM: http://releases.llvm.org/5.0.1/LLVM-5.0.1-win64.exe
2. During the installation, make sure to add it to your path
3. In QT Creator, select `Help` > `About Plugins` > `C++` > `Beautifier` to enable the plugin
4. Restart QT Creator
5. Select `Tools` > `Options` > `Beautifier`
6. Under `General` select `Tool: ClangFormat` and enable `Automatic Formatting on File Save`
7. Under `Clang Format` select `Use predefined style: File` and `Fallback style: None`
Qt creator should now format the documents when saving it.
