7325bf5901
Update README for IWYU 0.19
2022-11-02 19:48:02 +01:00
3a793604c1
[cmake] Support LLVM external project build
...
This makes it possible to build IWYU as part of LLVM using the
LLVM_EXTERNAL_PROJECTS feature of the LLVM build system.
Add separate instructions for this build mode to README.
Based on original patch from @bc-lee:
https://github.com/include-what-you-use/include-what-you-use/pull/994
2022-04-25 18:44:26 +02:00
f81b0fe26e
[doc] Separate compatibility notes from build
...
Edit content a little bit to get rid of reference to "build bot".
2022-04-24 17:01:53 +02:00
0636ec3f3e
[doc] Reduce emphasis
...
This sentence came across as a heading; make it less imposing.
2022-04-24 17:01:53 +02:00
e23a2f9807
[doc] Use sentence-case for headings
...
The use of title-case feels dated and is harder to get right consistently.
Rewrite all headings to plain sentence-case.
2022-04-24 17:01:53 +02:00
f4467365f8
doc: update README.md for 0.18 release
2022-04-15 12:13:07 +02:00
383a9afb9e
Update documentation for new exit codes
...
Some creative writing in both README and manpage.
2022-02-26 12:21:26 +01:00
8d1a3dd235
Update README for 0.17
2021-12-05 13:57:34 +01:00
6625c91793
Clarify usage instructions for CMake integration
...
Based on excellent input from @zchrissirhcz in issue #975 .
2021-12-05 12:59:43 +01:00
fb4948014b
Fix ambiguous wording in README
...
Nothing is eating anything else in this ecosystem
2021-07-06 19:23:54 +02:00
e4f3e8e8ee
Update README for 0.16
2021-05-28 21:09:10 +02:00
28e741bce0
Update README to point to GitHub CI
2021-04-11 17:05:12 +02:00
36d437e08e
Remove references to LLVM/Clang 'trunk'
...
LLVM and Clang have been in Git for a while now, so avoid 'trunk' in
favor of the actual branch name 'main'.
Update cmake command example for local build tree to use something more
akin to a real directory path.
2020-12-28 12:57:17 +01:00
f0240b92f3
Update references to Clang master -> main
...
The llvm-project repository just changed name of its mainline branch
from 'master' to 'main'.
Update our docs accordingly.
2020-12-28 12:57:17 +01:00
71220d36ea
Update README for 0.15
...
Also clean up the state of 'master' --
* Clang is all Git now, so refer to its master instead of 'trunk'
* IWYU master does not have a version
2020-11-21 22:29:01 +01:00
600732203a
Update table of clang versions in README.md
2020-09-26 16:38:55 +02:00
0cefeaf2ec
[docs] Remove half-truth that Clang 9 maps to IWYU master
...
Emphasize that IWYU master follows Clang trunk.
2019-10-19 21:14:38 +02:00
10320064ab
Clarify valid Clang and IWYU version combinations
...
Add a mapping table from Clang version to IWYU version and branch.
This should make it easier to navigate in the CMake configure-jungle.
Also clarify that the version numbers in the examples are placeholders.
2019-06-30 10:47:06 +02:00
ac6ce5f2fa
Freshen up How to Install section
...
There were some ambiguities, especially with non-standard
packaging. Recommend -print-resource-dir to find builtins
and try to clarify.
2018-12-26 16:54:21 +01:00
a42f5d356a
Modernize README caveat
...
IWYU is still/perpetually in alpha.
Tone down the connection between IWYU and Google, it's no longer
as strong.
Don't encourage "unit" test cases, we don't really have a unittest suite
at this point.
2018-08-12 19:07:03 +02:00
d1babfe532
Add custom markdownlint config and update docs to be markdownlint clean
2018-05-29 22:10:09 +02:00
54e875f9fd
Update build instructions for new CMake
2018-05-28 21:02:46 +02:00
7d778e5179
Fix typo: -Xwiyu -> -Xiwyu
2018-05-25 19:14:52 +02:00
9dd9a9e794
use a ; separated list like CMake requires it in documentation
2018-03-14 21:54:23 +01:00
07be0e2d01
Document compatibility branches
...
User feedback showed that docs around the release branches were not
obvious. Add some more up-front information.
2018-03-13 21:56:36 +01:00
cfbe189239
Create a travis script to build with latest LLVM
...
Concretely, it uses the latest available snapshot from apt.llvm.org
Closes #293
2017-10-24 21:40:50 +02:00
4fc7f61b41
Commit first canonical README
2017-07-09 22:37:48 +03:00
45e1264507
More complete usage instructions
...
Restructure to make room for more run modes
Add section on new CMake support
Add section on iwyu_tool.py
Regenerate README
2017-06-06 10:39:43 +02:00
89f8d1e9f8
Fix out-of-tree build for MSVC
...
We don't build with MSVC out-of-tree regularly, so a number of
compatibility issues with LLVM had snuck in:
- Suppressed warnings in header LLVM files
- Extended object format support (/bigobj)
- Use of noexcept requires sane C++ exception semantics (/EHSc)
- Clang's MSVCToolChain.cpp now uses functions from version.dll, so add it
to linker deps
While dabbling with this, we also found it was necessary to CMake with
-DCMAKE_BUILD_TYPE=Release to match LLVM's release-built libraries.
Mention this in the user docs.
2017-02-19 12:13:13 +01:00
f5e3a3e682
How to Run: Redirect stderr to /tmp/iwyu.out
...
The messages from include-what-you-use are printed on stderr, so redirect that
to the log file.
2017-01-22 16:05:06 +01:00
f0d04f75a3
Remove Makefile as it's not supported by LLVM+Clang.
...
Autoconf support was removed in LLVM and Clang in r258861 and r258862
respectively.
2016-02-06 18:14:33 -08:00
fdb4e4f319
Rewrite relative links so they can be followed on GitHub.
2015-09-02 22:35:48 +02:00
9d2fec2736
Add new generated README.md.
2015-08-30 22:07:46 +02:00
Kim Gräsman