From 88cd8f04b831952d11e31bc5f70ec6b228c3b39d Mon Sep 17 00:00:00 2001 From: Martin Wittlinger Date: Tue, 8 Feb 2022 09:37:02 +0100 Subject: [PATCH 1/2] fix typo, change supported plattforms and change badge --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index efc337404..2f05e299b 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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. @@ -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) From a3044140347560e8c44be04c3fdb4f6828a80b6d Mon Sep 17 00:00:00 2001 From: Aman Sharma Date: Tue, 8 Feb 2022 11:04:17 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2f05e299b..e5c158445 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If you use Sorald in an academic context, please cite: ### Prerequisites -Sorald supports macOS, Linux and, Windows. +Sorald supports macOS, Linux, and Windows. For running Sorald, all you need is a Java 11+ runtime.