diff --git a/README.md b/README.md index 3b72d7d4d6..d20b84cb80 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,35 @@ # kdev-clang-tidy -A plugin for [KDevelop](https://www.kdevelop.org) to support clang-tidy static analysis. +A plugin for [KDevelop](https://www.kdevelop.org) to support [clang-tidy](http://clang.llvm.org/extra/clang-tidy/) +static analysis. +It uses the [KDevelop5 Problem Checker Framework](https://techbase.kde.org/KDevelop5/Problem_Checker_Framework), parsing +clang-tidy's output and showing the issues on the Problems Viewer, allowing easy review of the code. ## Build and install +In order to build this plugin you must have the libraries for KDevPlatform and KDevelop installed into your system. +Get the source code from this repository(https://github.com/CarlosNihelton/kdev-clang-tidy), tweak it if you want, run +cmake to configure the project, build it and have fun. -## Contributing +## Screenshots +![clang-tidy output on Problem Viewer](/doc/cltd-1-default.png?raw=true) +![Per-project configuration page](/doc/cltd-2-projconf.png?raw=true) +![Tooltip/hint details clang-tidy check result](/doc/cltd-3-w-tooltip.png?raw=true) +![Global configuration](/doc/cltd-4-globalconfig.png?raw=true) ## License + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License + as published by the Free Software Foundation; either version 2 + of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + Copyright (C) 2016 by Carlos Nihelton diff --git a/doc/cltd-1-default.png b/doc/cltd-1-default.png new file mode 100644 index 0000000000..7e5802b16a Binary files /dev/null and b/doc/cltd-1-default.png differ diff --git a/doc/cltd-2-projconfig.png b/doc/cltd-2-projconfig.png new file mode 100644 index 0000000000..f6ad515f42 Binary files /dev/null and b/doc/cltd-2-projconfig.png differ diff --git a/doc/cltd-2-w-tooltip.png b/doc/cltd-2-w-tooltip.png new file mode 100644 index 0000000000..82456fe6ff Binary files /dev/null and b/doc/cltd-2-w-tooltip.png differ diff --git a/doc/cltd-4-globalconfig.png b/doc/cltd-4-globalconfig.png new file mode 100644 index 0000000000..3a01537330 Binary files /dev/null and b/doc/cltd-4-globalconfig.png differ