The current CI badge is currently in libc++ documentation. This does not
seem the right place:
- The typical location on GitHub is on the main README.
- The documentation is shipped as part of the release:
- This link does not work in off-line mode. Currently our documentation
works in off-line mode.
- The status in the release documentation does not reflect the status of
the shipped library. So users looking at it may see a red status and get
confused.
This moves the badge to the README.
The main README.md should probably be kept pretty short and be used to
point new-comers to the most essential ways to get started on or get
involved with LLVM.
Therefore, this patch removes a pointer to IRC (not used very much these
days), and does add pointers to office hours and online sync-ups.
Funnel fetching and building LLVM instructions into GettingStarted.
Modernize the build steps a little.
Remove comments saying CMAKE_BUILD_TYPE defaults to Debug as that's not true anymore (must explicitly pass it).
Reviewed By: MaskRay, hans
Differential Revision: https://reviews.llvm.org/D145413
We are moving away from building the runtimes with LLVM_ENABLE_PROJECTS,
however the documentation was largely outdated. This commit updates all
the documentation I could find to use LLVM_ENABLE_RUNTIMES instead of
LLVM_ENABLE_PROJECTS for building runtimes.
Note that in the near future, libcxx, libcxxabi and libunwind will stop
supporting being built with LLVM_ENABLE_PROJECTS altogether. I don't know
what the plans are for other runtimes like libc, openmp and compiler-rt,
so I didn't make any changes to the documentation that would imply
something for those projects.
Once this lands, I will also cherry-pick this on the release/14.x branch
to make sure that LLVM's documentation is up-to-date and reflects what
we intend to support in the future.
Differential Revision: https://reviews.llvm.org/D119351
The updated list is based on the output of
cmake -G Ninja -S llvm -B build -DLLVM_ENABLE_PROJECTS='foo'.
Differential Revision: https://reviews.llvm.org/D110124
As discussed on llvm-dev [1], this patch adds a brief CONTRIBUTING.md to
the top-level of the repo, with a pointer to Contributing.html. This
should make it easier to discover the contributing information and also
be highlighted in the Github UI.
It also updates README.md to link to Contributing.html.
[1] http://lists.llvm.org/pipermail/llvm-dev/2019-November/137141.html
Reviewers: tonic, rnk, jhenderson, meikeb
Reviewed By: rnk, jhenderson, meikeb
Differential Revision: https://reviews.llvm.org/D70743
Reviewed and approved by chandlerc.
As GitHub is the canonical LLVM repository now, embrace GitHub's way of displaying basic build instructions in the top-level readme.md.
