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

doc(readme): update supported platforms and fix typo #728

Merged
merged 2 commits into from
Feb 8, 2022
Merged

doc(readme): update supported platforms and fix typo #728

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88cd8f0
fix typo, change supported plattforms and change badge
MartinWitt Feb 8, 2022
a304414
Update README.md
algomaster99 Feb 8, 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
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sorald [![GHA tests Workflow Status](https://github.com/SpoonLabs/sorald/actions/workflows/tests.yml/badge.svg)](https://github.com/SpoonLabs/sorald/actions/workflows/tests.yml) [![Code Coverage](https://codecov.io/gh/SpoonLabs/sorald/branch/master/graph/badge.svg)](https://codecov.io/gh/SpoonLabs/sorald) ![Supported Platforms](https://img.shields.io/badge/platforms-Linux%2C%20macOS-blue.svg)
# Sorald [![GHA tests Workflow Status](https://github.com/SpoonLabs/sorald/actions/workflows/tests.yml/badge.svg)](https://github.com/SpoonLabs/sorald/actions/workflows/tests.yml) [![Code Coverage](https://codecov.io/gh/SpoonLabs/sorald/branch/master/graph/badge.svg)](https://codecov.io/gh/SpoonLabs/sorald) ![Supported Platforms](https://img.shields.io/badge/platforms-Linux%2C%20macOS%2C%20Windows-blue.svg)
Sorald is a tool to automatically repair violations of static analysis rules checked with [SonarQube](https://rules.sonarsource.com).
It can currently repair violations of [25+ rules](/docs/HANDLED_RULES.md) based on the design described [Sorald: Automatic Patch Suggestions for SonarQube Static Analysis Violations](http://arxiv.org/pdf/2103.12033).

Expand All @@ -19,9 +19,7 @@ If you use Sorald in an academic context, please cite:

### Prerequisites

Sorald supports macOS and Linux, with
[currently partial support for Windows (some features may not work
yet)](https://github.com/spoonlabs/sorald/issues/273).
Sorald supports macOS, Linux, and Windows.

For running Sorald, all you need is a Java 11+ runtime.

Expand Down Expand Up @@ -65,7 +63,7 @@ alias sorald='java -jar /abs/path/to/sorald.jar'
```

If you don't like using aliases, simply substitute in `java -jar sorald.jar`
for any occurence of `sorald` in these instructions.
for any occurrence of `sorald` in these instructions.

#### Repairing rule violations (the `repair` command)

Expand Down