aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTomasz Kramkowski <tk@the-tk.com>2021-08-06 15:49:26 +0100
committerTomasz Kramkowski <tk@the-tk.com>2021-08-06 15:49:26 +0100
commita6f62055835c5c3f9546818fbbcd43c73baef57f (patch)
treee0fc0a7a94dafbf1ad65776d58e6ac1cb4208f2a /README.md
parente895879eac788f1d59a68d4d0ef7f3788e159842 (diff)
downloadpack-a6f62055835c5c3f9546818fbbcd43c73baef57f.tar.gz
pack-a6f62055835c5c3f9546818fbbcd43c73baef57f.tar.xz
pack-a6f62055835c5c3f9546818fbbcd43c73baef57f.zip
Implement compile_commands.json generation
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/README.md b/README.md
index 678abc3..25038b3 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,7 @@ Pack has no runtime dependencies. The following is a list of build dependencies:
- POSIX cat, find, rm, sed, sh and tr
- xargs with support for the `-r` gnu extension
- bash 4.4 or newer (parameter expansion transformations)
+- (optional) jq (for generating `compile_commands.json`)
Compilation
-----------
@@ -76,6 +77,9 @@ Development
Please configure with `-w` and ensure code compiles cleanly. Be aware that
different compiler versions can enable different warnings. If in doubt, ask.
+If you use a tool such as `clangd` which makes use of `compile_commands.json`
+then make sure you have `jq` installed and run `./configure` with `-f`.
+
Contributing
------------