From 8e7c3f963330b2b78813f030d35d9cbdac14573d Mon Sep 17 00:00:00 2001 From: eidheim Date: Mon, 19 Oct 2015 13:43:21 +0200 Subject: [PATCH] Cleanup of clang-format documentation. --- README.md | 2 +- docs/install.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ace3b6d..d36d1d2 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ towards libclang with speed and ease of use in mind. * Run shell commands within JuCi++, even on Windows * Regex search and replace * Smart paste, keys and indentation -* Auto-indentation of files through clang-format (on some systems you need to create a symbolic link `/usr/local/bin/clang-format` to a specific installed clang-format-version) +* Auto-indentation of C++ file buffers through [clang-format](http://clang.llvm.org/docs/ClangFormat.html) * Source minimap * Full UTF-8 support diff --git a/docs/install.md b/docs/install.md index 3b09431..95bcaa0 100644 --- a/docs/install.md +++ b/docs/install.md @@ -15,6 +15,12 @@ make sudo make install ``` +To use clang-format for auto-indentation of C++ files (replace \[version\] with an available clang-format version): +```sh +sudo apt-get install clang-format-[version] +sudo ln -s /usr/bin/clang-format-[version] /usr/local/bin/clang-format +``` + ## Ubuntu 14/Linux Mint 17 Install dependencies: ```sh @@ -34,6 +40,12 @@ make sudo make install ``` +To use clang-format for auto-indentation of C++ files (replace \[version\] with an available clang-format version): +```sh +sudo apt-get install clang-format-[version] +sudo ln -s /usr/bin/clang-format-[version] /usr/local/bin/clang-format +``` + ## OS X with Homebrew (http://brew.sh/) Install dependencies (installing llvm may take some time): ```sh