aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2022-07-31 14:19:03 +0200
committerJay Berkenbilt <ejb@ql.org>2022-07-31 14:21:53 +0200
commitc9cc8cfd74fdb59d5450939e1772dea35d369b04 (patch)
tree4c049a59e612437635b80d31d4db9bc0ac40d9bb
parent4674c04cb80e0a50cde1b97464642e2778f9522f (diff)
downloadqpdf-c9cc8cfd74fdb59d5450939e1772dea35d369b04.tar.zst
Remove lgtm banner
Over time, qpdf's grade has dropped on lgtm, but they are not transparent about how grades are assigned. Fixing current alerts, in my opinion, reduces clarity and maintainability of the code in the name of performance in non-critical sections of code. Some analysis by m-holger suggests that fixing some of the current alerts actually degrades performance (slightly) while fixing others results in insignificant improvements. The quality of qpdf can be measured in other ways, such as its extensive test suite, documentation, and long track record of reliably manipulating PDFs with high performance, few bugs, and few external dependencies. The lgtm rating is a distraction at best.
-rw-r--r--README-maintainer3
-rw-r--r--README.md2
2 files changed, 2 insertions, 3 deletions
diff --git a/README-maintainer b/README-maintainer
index 29291634..c2967c99 100644
--- a/README-maintainer
+++ b/README-maintainer
@@ -291,7 +291,8 @@ RELEASE PREPARATION
* Check for open fuzz crashes at https://oss-fuzz.com
-* Check lgtm: https://lgtm.com/projects/g/qpdf/qpdf/?mode=list
+* Check lgtm: https://lgtm.com/projects/g/qpdf/qpdf/?mode=list for
+ anything worth fixing
* Check all open issues and pull requests in github and the
sourceforge trackers. See ~/scripts/github-issues. Don't forget pull
diff --git a/README.md b/README.md
index 05aa8d00..f768adfb 100644
--- a/README.md
+++ b/README.md
@@ -3,8 +3,6 @@
[![QPDF](logo/qpdf.svg)](https://qpdf.sourceforge.io)
[![QPDF Build](https://github.com/qpdf/qpdf/workflows/QPDF%20Build/badge.svg)](https://github.com/qpdf/qpdf/actions)
-[![Total lgtm alerts](https://img.shields.io/lgtm/alerts/g/qpdf/qpdf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/qpdf/qpdf/alerts/)
-[![Language grade on lgtm: C/C++](https://img.shields.io/lgtm/grade/cpp/g/qpdf/qpdf.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/qpdf/qpdf/context:cpp)
[![Documentation Status](https://readthedocs.org/projects/qpdf/badge/?version=latest)](https://qpdf.readthedocs.io/en/latest/?badge=latest)
QPDF is a command-line tool and C++ library that performs content-preserving transformations on PDF files. It supports linearization, encryption, and numerous other features. It can also be used for splitting and merging files, creating PDF files (but you have to supply all the content yourself), and inspecting files for study or analysis. QPDF does not render PDFs or perform text extraction, and it does not contain higher-level interfaces for working with page contents. It is a low-level tool for working with the structure of PDF files and can be a valuable tool for anyone who wants to do programmatic or command-line-based manipulation of PDF files.