From 2fc774eece90c26f422c00c60fa397638aba06fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89der=20F=2E=20Zulian?= Date: Mon, 9 Apr 2018 08:34:47 +0200 Subject: [PATCH] DRAMSys.astylerc, doc and install script updated --- DRAMSys/DRAMSys.astylerc | 11 ++++++++++- coding-style.md | 17 +++++++++++++++++ utils/install.sh | 2 ++ 3 files changed, 29 insertions(+), 1 deletion(-) diff --git a/DRAMSys/DRAMSys.astylerc b/DRAMSys/DRAMSys.astylerc index f678ccfe..52adf134 100644 --- a/DRAMSys/DRAMSys.astylerc +++ b/DRAMSys/DRAMSys.astylerc @@ -1 +1,10 @@ ---style=attach +--style=kr +--indent=spaces=4 +--align-pointer=name +--align-reference=name +--convert-tabs +--attach-namespaces +--max-code-length=80 +--max-instatement-indent=100 +--pad-header +--pad-oper diff --git a/coding-style.md b/coding-style.md index 72cbb01a..7ac4d388 100644 --- a/coding-style.md +++ b/coding-style.md @@ -17,6 +17,18 @@ limit, for example), just do it. Since DRAMSys is a multi-language project, each with its own peculiarities, we describe the preferred coding style for them in separate. +## Tools + +```bash +sudo apt-get -y install astyle +sudo apt-get -y install uncrustify +sudo apt-get -y install clang-format +``` + +**Hint:** +You can use [utils/install.sh](./utils/install.sh) in order to install +dependencies. First read and understand the script then execute it. Type your +password if required. ## DRAMSys Coding Style for C++ Code @@ -73,3 +85,8 @@ describe the preferred coding style for them in separate. [Qt Documentation - Beautifying Source Code](http://doc.qt.io/qtcreator/creator-beautifier.html) [Artistic Style 3.1 - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective‑C, C#, and Java Source Code](http://astyle.sourceforge.net/astyle.html) + +[Qt Coding Style](https://wiki.qt.io/Qt_Coding_Style) + +[Qt Coding Conventions](https://wiki.qt.io/Coding_Conventions) + diff --git a/utils/install.sh b/utils/install.sh index 3caa266a..56370bb1 100755 --- a/utils/install.sh +++ b/utils/install.sh @@ -56,3 +56,5 @@ sudo apt-get -y install libqt5core5a sudo apt-get -y install qtcreator sudo apt-get -y install qt5-default sudo apt-get -y install astyle +sudo apt-get -y install uncrustify +sudo apt-get -y install clang-format