Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Apply small README improvements #266

Merged
merged 4 commits into from
Sep 28, 2022
Merged

Apply small README improvements #266

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6faa5c1
Assorted README suggestions
sandermak Sep 27, 2022
51ad67c
Change Building to Developing
sandermak Sep 28, 2022
80dcc80
Tweaks
japborst Sep 28, 2022
313ce8a
Tweaks
Stephan202 Sep 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@

# Error Prone Support

Error Prone Support is a Picnic-opinionated extension of Google's [Error
Prone][error-prone-orig-repo]. It aims to improve code quality, focussing on
maintainability, consistency and avoidance of common gotchas.
Error Prone Support is a [Picnic][picnic-blog]-opinionated extension of
Google's [Error Prone][error-prone-orig-repo]. It aims to improve code quality,
focussing on maintainability, consistency and avoidance of common pitfalls.

> Error Prone is a static analysis tool for Java that catches common
> programming mistakes at compile-time.
Expand All @@ -20,7 +20,8 @@ maintainability, consistency and avoidance of common gotchas.
[![License][license-badge]][license]
[![PRs Welcome][pr-badge]][contributing]

[Getting started](#-getting-started) • [Building](#-building) •
[Getting started](#-getting-started) •
[Developing Error Prone Support](#-developing-error-prone-support) •
[How it works](#-how-it-works) • [Contributing](#%EF%B8%8F-contributing)

</div>
Expand Down Expand Up @@ -139,10 +140,11 @@ Two things are kicking in here:
Be sure to check out all [bug checks][bug-checks] and [refaster
templates][refaster-templates].

## 👷 Building
## 👷 Developing Error Prone Support

This is a [Maven][maven] project, so running `mvn clean install`
performs a full clean build. Some relevant flags:
This is a [Maven][maven] project, so running `mvn clean install` performs a
full clean build and installs the library to your local Maven repository. Some
relevant flags:

- `-Dverification.warn` makes the warnings and errors emitted by various
plugins and the Java compiler non-fatal, where possible.
Expand Down Expand Up @@ -216,6 +218,7 @@ guidelines][contributing].
[maven-central-badge]: https://img.shields.io/maven-central/v/tech.picnic.error-prone-support/error-prone-support?color=blue
[maven-central-search]: https://search.maven.org/artifact/tech.picnic.error-prone-support/error-prone-support
[maven]: https://maven.apache.org
[picnic-blog]: https://blog.picnic.nl
[pitest]: https://pitest.org
[pitest-maven]: https://pitest.org/quickstart/maven
[pr-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
Expand Down