Skip to content

Commit 7a6925b

Browse files
committed
Update README.md
1 parent ed80166 commit 7a6925b

File tree

8 files changed

+72
-78
lines changed

8 files changed

+72
-78
lines changed

README.md

Lines changed: 63 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
![Logo](docs/resources/creedengo_logo.png)
2-
======================================
1+
<div align="center">
2+
<picture>
3+
<source media="(prefers-color-scheme: dark)" width="500" height="100" srcset="docs/resources/creedengo_light.svg">
4+
<source media="(prefers-color-scheme: light)" width="500" height="100" srcset="docs/resources/creedengo_dark.svg">
5+
<img alt="Creedengo logo" width="500" height="100" src="docs/resources/creedengo_light.svg">
6+
</picture>
7+
<p>
8+
<strong>A Green Code Initiative project</strong>
9+
</p>
10+
</div>
11+
12+
---
313

414
_creedengo_ is a collective project aiming to reduce environmental footprint of software at the code level. The goal of
515
the project is to provide a list of static code analyzers to highlight code structures that may have a negative
@@ -14,22 +24,21 @@ refer to the contribution section.
1424
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
1525
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/CODE_OF_CONDUCT.md)
1626

17-
🌿 SonarQube Plugins
18-
-------------------
27+
## 🌿 SonarQube Plugins
1928

2029
7 technologies are supported by creedengo right now:
2130

2231
- "standard" plugins :
23-
- [Java plugin](https://github.com/green-code-initiative/creedengo-java)
24-
- [JavaScript plugin](https://github.com/green-code-initiative/creedengo-javascript)
25-
- [PHP plugin](https://github.com/green-code-initiative/creedengo-php)
26-
- [Python plugin](https://github.com/green-code-initiative/creedengo-python)
27-
- [C# plugin](https://github.com/green-code-initiative/creedengo-csharp)
32+
- [Java plugin](https://github.com/green-code-initiative/creedengo-java)
33+
- [JavaScript plugin](https://github.com/green-code-initiative/creedengo-javascript)
34+
- [PHP plugin](https://github.com/green-code-initiative/creedengo-php)
35+
- [Python plugin](https://github.com/green-code-initiative/creedengo-python)
36+
- [C# plugin](https://github.com/green-code-initiative/creedengo-csharp)
2837
- mobile plugins :
29-
- [Android plugin](https://github.com/green-code-initiative/ecoCode-android)
30-
- [iOS plugin](https://github.com/green-code-initiative/creedengo-ios)
38+
- [Android plugin](https://github.com/green-code-initiative/ecoCode-android)
39+
- [iOS plugin](https://github.com/green-code-initiative/creedengo-ios)
3140

32-
![Screenshot](docs/resources/screenshot.PNG)
41+
![Screenshot](docs/resources/screenshot.jpg)
3342

3443
### eco-design SonarQube plugin
3544

@@ -96,75 +105,60 @@ in order to allow the inclusion of other pages (this feature is not available in
96105

97106
See:
98107

99-
* [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/)
100-
* [Compare AsciiDoc to Markdown](https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/)
108+
- [AsciiDoc Syntax Quick Reference](https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/)
109+
- [Compare AsciiDoc to Markdown](https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/)
101110

111+
## 🚀 Getting Started
102112

103-
🚀 Getting Started
104-
------------------
105-
106-
You can quickly have a look of creedengo plugins with docker. Plase have a look at "Getting started" section of each plugin :
113+
You can quickly explore Creedengo plugins using Docker. Refer to the "Getting Started" section of each plugin for
114+
detailed instructions:
107115

108116
- [Java plugin](https://github.com/green-code-initiative/creedengo-java?tab=readme-ov-file#-getting-started)
109117
- [PHP plugin](https://github.com/green-code-initiative/creedengo-php?tab=readme-ov-file#-getting-started)
110118
- [Python plugin](https://github.com/green-code-initiative/creedengo-python?tab=readme-ov-file#-getting-started)
111119
- [C# plugin](https://github.com/green-code-initiative/creedengo-csharp?tab=readme-ov-file#-getting-started)
112120
- [Android Java plugin](https://github.com/green-code-initiative/ecoCode-android?tab=readme-ov-file#-quickstart)
113121

114-
🛒 Distribution
115-
------------------
122+
## 🛒 Distribution
116123

117-
The main way to get creedengo plugins is to download them from your SonarQube Marketplace (available in Administration section).
118-
But if you want, you can also download them from GitHub releases.
124+
The primary way to obtain Creedengo plugins is through the SonarQube Marketplace, accessible in the Administration
125+
section. Alternatively, you can download them directly from the GitHub releases.
119126

120127
We had split our plugins repository `creedengo` to one repository for each plugin on december 2023.
121128
Thus, plugin versions are available on 2 repositories depending on version you want :
122129

123130
- Java plugin :
124-
- from 0.x to 1.4.3 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
125-
- since 1.5.0 : [creedengo-java repository](https://github.com/green-code-initiative/creedengo-java/releases)
131+
- from 0.x to
132+
1.4.3 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
133+
- since 1.5.0 : [creedengo-java repository](https://github.com/green-code-initiative/creedengo-java/releases)
126134
- PHP plugin :
127-
- from 0.x to 1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
128-
- since 1.4.0 : [creedengo-php repository](https://github.com/green-code-initiative/creedengo-php/releases)
135+
- from 0.x to
136+
1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
137+
- since 1.4.0 : [creedengo-php repository](https://github.com/green-code-initiative/creedengo-php/releases)
129138
- Python plugin :
130-
- from 0.x to 1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
131-
- since 1.4.0 : [creedengo-python repository](https://github.com/green-code-initiative/creedengo-python/releases)
139+
- from 0.x to
140+
1.3.1 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
141+
- since 1.4.0 : [creedengo-python repository](https://github.com/green-code-initiative/creedengo-python/releases)
132142
- Javascript plugin :
133-
- from 0.x to 1.3.0 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
134-
- since 1.4.0 : [creedengo-javascript repository](https://github.com/green-code-initiative/creedengo-javascript/releases)
143+
- from 0.x to
144+
1.3.0 : [creedengo repository](https://github.com/green-code-initiative/creedengo-rules-specifications/releases)
145+
- since
146+
1.4.0 : [creedengo-javascript repository](https://github.com/green-code-initiative/creedengo-javascript/releases)
135147
- C# plugin :
136-
- since 0.x : [creedengo repository](https://github.com/green-code-initiative/creedengo-csharp/releases)
148+
- since 0.x : [creedengo repository](https://github.com/green-code-initiative/creedengo-csharp/releases)
137149
- Android plugin : [creedengo-android repository](https://github.com/green-code-initiative/ecoCode-android/releases)
138150
- iOS plugin : [creedengo-ios repository](https://github.com/green-code-initiative/creedengo-ios/releases)
139151

140-
🧩 Plugins version compatibility (OLD `ecocode` plugin)
141-
------------------
142-
143-
| Plugins Version | SonarQube version |
144-
|------------------|-----------------------------|
145-
| 1.4.+ | SonarQube 9.4.+ LTS to 10.1 |
146-
| 1.3.+ | SonarQube 9.4.+ LTS to 10.0 |
147-
| 1.2.+ | SonarQube 9.4.+ LTS to 10.0 |
148-
| 1.1.+ | SonarQube 9.4.+ LTS to 9.9 |
149-
| 1.0.+ | SonarQube 9.4.+ LTS to 9.9 |
150-
| 0.2.+ | SonarQube 9.4.+ LTS to 9.9 |
151-
| 0.1.+ | SonarQube 8.9.+ LTS to 9.3 |
152-
153-
☕ Plugin Java part compatibility (OLD `ecocode` plugin)
154-
------------------
155-
156-
| Plugins Version | Java version |
157-
|------------------|--------------|
158-
| 1.4.+ | 11 / 17 |
159-
| 1.3.+ | 11 / 17 |
160-
| 1.2.+ | 11 / 17 |
161-
| 1.1.+ | 11 / 17 |
162-
| 1.0.+ | 11 / 17 |
163-
| 0.2.+ | 11 / 17 |
164-
| 0.1.+ | 11 / 17 |
165-
166-
🤝 Contribution
167-
---------------
152+
## 🧩 Plugins version compatibility (OLD `ecocode` plugin)
153+
154+
| Plugins Version | SonarQube version | Java version |
155+
|---------------------|-----------------------------|--------------|
156+
| 1.4+ | SonarQube 9.4.+ LTS to 10.1 | 11 / 17 |
157+
| 1.2.x, 1.3.x | SonarQube 9.4.+ LTS to 10.0 | 11 / 17 |
158+
| 0.2.x, 1.0.x, 1.1.x | SonarQube 9.4.+ LTS to 9.9 | 11 / 17 |
159+
| 0.1.x | SonarQube 8.9.+ LTS to 9.3 | 11 / 17 |
160+
161+
## 🤝 Contribution
168162

169163
You are a technical expert, a designer, a project manager, a CSR expert, an ecodesign expert...
170164

@@ -176,10 +170,9 @@ We are listening to you to make the project progress collectively, and maybe wit
176170

177171
WE NEED YOU !
178172

179-
Here the [Starter pack](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/starter-pack.md)
173+
Here is the [Starter pack](https://github.com/green-code-initiative/creedengo-common/blob/main/doc/starter-pack.md)
180174

181-
🤓 Main contributors
182-
--------------------
175+
## 🤓 Main contributors
183176

184177
Any question ? We are here for you !
185178
first, create an issue, please.
@@ -190,19 +183,18 @@ Then, if no answer, contact ...
190183
- [Julien Hertout](https://www.linkedin.com/in/julien-hertout-b1175449/)
191184
- [Justin Berque](https://www.linkedin.com/in/justin-berque-444412140)
192185
- [Olivier Le Goaër](https://olegoaer.perso.univ-pau.fr)
193-
- [Maxime DUBOIS](https://www.linkedin.com/in/maxime-dubois-%F0%9F%8C%B1-649a3a3/)
194-
- [David DE CARVALHO](https://www.linkedin.com/in/david%E2%80%8E-de-carvalho-8b395284/)
195-
- [Maxime MALGORN](https://www.linkedin.com/in/maximemalgorn/)
196-
- [Gilles GROUSSET](https://www.linkedin.com/in/gillesgrousset/)
197-
- [Vianney DE BELLABRE](https://www.linkedin.com/in/vianney-de-bellabre/)
198-
- [Jérôme CARDON](https://www.linkedin.com/in/jcardon79/)
199-
- [Johanna DUIGOU](https://www.linkedin.com/in/johannaduigou/)
186+
- [David De Carvalho](https://www.linkedin.com/in/david%E2%80%8E-de-carvalho-8b395284/)
187+
- [Maxime Malgorn](https://www.linkedin.com/in/maximemalgorn/)
188+
- [Gilles Grousset](https://www.linkedin.com/in/gillesgrousset/)
189+
- [Vianney De Bellabre](https://www.linkedin.com/in/vianney-de-bellabre/)
190+
- [Jérôme Cardon](https://www.linkedin.com/in/jcardon79/)
191+
- [Johanna Duigou](https://www.linkedin.com/in/johannaduigou/)
200192

201-
🧐 Core Team Emeriti
202-
--------------------
193+
## 🧐 Core Team Emeriti
203194

204195
Here we honor some no-longer-active core team members who have made valuable contributions in the past.
205196

197+
- [Maxime Dubois](https://www.linkedin.com/in/maxime-dubois-%F0%9F%8C%B1-649a3a3/)
206198
- Gaël Pellevoizin
207199
- [Nicolas Daviet](https://github.com/NicolasDaviet)
208200
- [Mathilde Grapin](https://github.com/fkotd)
@@ -220,8 +212,3 @@ They have contributed to the success of creedengo :
220212
They supported the project :
221213

222214
- [Région Nouvelle-Aquitaine](https://www.nouvelle-aquitaine.fr/)
223-
224-
Links
225-
-----
226-
227-
- https://docs.sonarqube.org/latest/analysis/overview/

docs/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
![Logo](resources/creedengo_logo.png)
1+
<picture>
2+
<source media="(prefers-color-scheme: dark)" width="500" height="100" srcset="resources/creedengo_light.svg">
3+
<source media="(prefers-color-scheme: light)" width="500" height="100" srcset="resources/creedengo_dark.svg">
4+
<img alt="Creedengo logo" width="500" height="100" src="resources/creedengo_light.svg">
5+
</picture>
26

37
---
48

@@ -8,6 +12,7 @@ Find official resources associated to creedengo project [here](resources)
812

913
## 📜 Rules
1014

11-
creedengo is based on evolving catalogs of [good practices](rules), for various technologies. A SonarQube plugin then implement these catalogs as rules for scanning your projects.
15+
creedengo is based on evolving catalogs of [good practices](rules), for various technologies. A SonarQube plugin then
16+
implement these catalogs as rules for scanning your projects.
1217

1318
These catalogs of rules are listed [here](rules)

docs/resources/challenge-logo.png

-35.5 KB
Binary file not shown.

docs/resources/creedengo_dark.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/resources/creedengo_light.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/resources/creedengo_logo.png

-44.6 KB
Binary file not shown.

docs/resources/screenshot.PNG

-68 KB
Binary file not shown.

docs/resources/screenshot.jpg

33.2 KB
Loading

0 commit comments

Comments
 (0)