From 9801c2e088c6fbf1d0e771b8761999a74d6f5264 Mon Sep 17 00:00:00 2001 From: Marcin Stachniuk Date: Fri, 13 Dec 2024 09:08:34 +0100 Subject: [PATCH] Improve readme --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 45dfe769..23b0bd48 100644 --- a/README.md +++ b/README.md @@ -22,29 +22,40 @@ If you are on Windows, read the [sonar-go-to-slang/README.md](sonar-go-to-slang/ ### Build Build and run Unit Tests: - ./gradlew build - +```shell +./gradlew build +``` +` ## Integration Tests By default, Integration Tests (ITs) are skipped during builds. If you want to run them, you need first to retrieve the related projects which are used as input: - git submodule update --init its/sources +```shell +git submodule update --init +``` Then build and run the Integration Tests using the `its` property: +```shell ./gradlew build -Pits --info --no-daemon +``` You can also build and run only Ruling Tests using the `ruling` property: - ./gradlew build -Pruling --info --no-daemon +```shell +./gradlew build -Pruling --info --no-daemon +``` ## License headers License headers are automatically updated by the spotless plugin but only for Java files. Furthermore, there are files such as `package-info.java` and `module-info.java` that spotless ignores. Also the Go source files are not handled. For those files use a manual script like below to update the license: - `find . -type f -name "*.go" -exec sed -i '' 's/2018-2023/2018-2024/' "{}" \;` + +```shell +`find . -type f -name "*.go" -exec sed -i '' 's/2018-2023/2018-2024/' "{}" \;` +``` ## License