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

Documentation update #24

Merged
merged 4 commits into from
May 28, 2024
Merged

Documentation update #24

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
488262c
doc: updated doc to mention rules profile configuration
Apr 29, 2024
8f6e952
doc: removed typo
Apr 29, 2024
93ee982
Merge branch 'main' into feature/doc-update
May 17, 2024
55b341c
Update README.md
zippy1978 May 27, 2024
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,11 @@ ecoCode iOS SonarQube plugin is an "eco-responsibility" static code analyzer for

Ready to use binaries are available [from GitHub](https://github.com/green-code-initiative/ecoCode-ios/releases).

NB: To work, `ecocode-ios` needs `Swift` language support in SonarQube. For *SonarQube Community Edition* (which does not support Swift language), you need to install an additional plugin like [sonar-apple](https://github.com/insideapp-oss/sonar-apple).
> NB: To work, `ecocode-ios` needs `Swift` language support in SonarQube. For *SonarQube Community Edition* (which does not support Swift language), you need to install an additional plugin like [sonar-apple](https://github.com/insideapp-oss/sonar-apple).

By default ecoCode profile is not activated. To activate ecoCode rules in SonarQube, create a new profile (or extend and existing one) where ecoCode rules are activated. Here is an example:
zippy1978 marked this conversation as resolved.
Show resolved Hide resolved

![Profiles](docs/resources/profiles.png)

🚀 Development Quickstart
-------------
Expand Down
Binary file added docs/resources/profiles.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading