diff options
author | Sergio Martins <smartins@kdab.com> | 2018-11-15 19:04:36 +0000 |
---|---|---|
committer | Sergio Martins <smartins@kde.org> | 2018-11-15 19:09:56 +0000 |
commit | 1fe272b6f8a34c8e3c85182220879f60b8d970fd (patch) | |
tree | e6f5ef904913c7795e00048131acc2ebd2681efd | |
parent | 7161845c3a948788f4d2b498d5cf9755d28358b2 (diff) |
README: Mention the app images and improve docs of pre-built package
BUG: 399853
-rw-r--r-- | README.md | 19 |
1 files changed, 9 insertions, 10 deletions
@@ -7,13 +7,13 @@ Table of contents ================= * [Source Code](#source-code) + * [](#pre-built-binaries) * [Build Instructions](#build-instructions) * [Linux](#linux) * [Install dependencies](#install-dependencies) * [Build and install clang](#build-and-install-clang) * [Build clazy](#build-clazy) * [Windows](#windows) - * [3rdparty pre-built msvc2015 clang and clazy binaries](#3rdparty-pre-built-msvc2015-clang-and-clazy-binaries) * [Build and install clang](#build-and-install-clang-1) * [Build clazy](#build-clazy-1) * [macOS with MacPorts](#macos-with-macports) @@ -44,6 +44,11 @@ You can get clazy from: - git@git.kde.org:clazy - git://anongit.kde.org/clazy +# Pre-built binaries + +Pre-built binaries are produced by KDAB, you can get them from https://downloads.kdab.com/clazy/. +Currently MSVC2015, MSVC2017 and Linux AppImage packages are provided. All of them are based on clang 7.0. + # Build Instructions ## Linux @@ -81,14 +86,6 @@ See troubleshooting section if you have problems. ## Windows -### 3rdparty pre-built msvc2015 clang and clazy binaries - -Building for Windows is a lengthy and tedious task, therefore the maintainer won't be creating them anymore on his free/KDE time. -KDAB however has offered to produce these binaries and they will appear on their website. - -If you really want to build clang and clazy yourself then read on, otherwise skip the building topic. - - ### Build and install clang These instructions assume your terminal is suitable for development (msvc2015). jom, nmake, git, cmake and cl should be in your PATH. @@ -172,7 +169,7 @@ $ brew install --with-clang llvm # Setting up your project to build with clazy -Note: Wherever `clazy` it mentioned, replace with `clazy-cl.bat` if you're on Windows. +Note: Wherever `clazy` it mentioned, replace with `clazy-cl.bat` if you're on Windows, or replace with `Clazy-x86_64.AppImage` if you're using AppImage. Note: If you prefer running clazy over a JSON compilation database instead of using it as a plugin, jump to [clazy-standalone](#clazy-standalone-and-json-database-support). You should now have the clazy command available to you, in `<prefix>/bin/`. @@ -326,6 +323,8 @@ The `clazy-standalone` binary allows you to run clazy over a compilation databas way you would use `clang-tidy` or other clang tooling. This way you don't need to build your application, only the static analysis is performed. +Note: If you're using the AppImage, use `Clazy-x86_64.AppImage --standalone` instead of `clazy-standalone`. + `clazy-standalone` supports the same env variables as the clazy plugin. You can also specify a list of checks via the `-checks` argument. |