Skip to content

Commit 6ee28a9

Browse files
committed
Update README.md
1 parent 12572c8 commit 6ee28a9

File tree

2 files changed

+18
-28
lines changed

2 files changed

+18
-28
lines changed

INSTALL.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
- [Project structure](#project-structure)
2-
- [Plugin-specific guides](#plugin-specific-guides)
3-
41
Common installation notes / requirements
52
========================================
63

@@ -25,8 +22,3 @@ ecoCode-php # Root directory
2522
```
2623

2724
You will find more information about the plugins’ architecture in their folders
28-
29-
Plugin-specific guides
30-
----------------------
31-
32-
- [PHP how-to](php-plugin/README.md)

README.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,55 +5,53 @@ _ecoCode_ is a collective project aiming to reduce environmental footprint of so
55
the project is to provide a list of static code analyzers to highlight code structures that may have a negative
66
ecological impact: energy and resources over-consumption, "fatware", shortening terminals' lifespan, etc.
77

8-
_ecoCode_ is based on evolving catalogs of [good practices](docs/rules), for various technologies. A SonarQube plugin
9-
then implements these catalogs as rules for scanning your projects.
8+
_ecoCode_ is based on evolving catalogs
9+
of [good practices](https://github.com/green-code-initiative/ecoCode/blob/main/docs/rules), for various technologies.
10+
This
11+
SonarQube plugin then implements these catalogs as rules for scanning your Python projects.
1012

11-
**Warning**: this is still a very early stage project. Any feedback or contribution will be highly appreciated. Please
12-
refer to the contribution section.
13+
> ⚠️ This is still a very early stage project. Any feedback or contribution will be highly appreciated. Please
14+
> refer to the contribution section.
1315
1416
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
1517
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/green-code-initiative/ecoCode-common/blob/main/doc/CODE_OF_CONDUCT.md)
1618

1719
🌿 SonarQube Plugins
1820
-------------------
1921

20-
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode)
22+
This plugin is part of the ecoCode project.\
23+
You can find a list of all our other plugins in
24+
the [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-sonarqube-plugins)
2125

2226
🚀 Getting Started
2327
------------------
2428

25-
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode)
29+
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-getting-started)
2630

2731
🛒 Distribution
2832
------------------
2933

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

32-
🧩 Plugins version compatibility
36+
🧩 Compatibility
3337
------------------
3438

35-
| Plugins Version | SonarQube version |
36-
|------------------|-----------------------------|
37-
| <= 1.3.+ | check [ecoCode](https://github.com/green-code-initiative/ecoCode) repository |
38-
| 1.4.+ | SonarQube 9.4.+ LTS to 10.0 |
39+
| Plugin version | SonarQube version | Java version |
40+
|----------------|-------------------|--------------|
41+
| 1.4.+ | 9.4.+ LTS to 10.1 | 11 / 17 |
3942

40-
☕ Plugin Java part compatibility
41-
------------------
42-
43-
| Plugins Version | Java version |
44-
|------------------|-----------------------------|
45-
| <= 1.3.+ | check [ecoCode](https://github.com/green-code-initiative/ecoCode) repository |
46-
| 1.4.+ | 11 / 17 |
43+
> Compatibility table of versions lower than 1.4.+ are available from the
44+
> main [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-plugins-version-compatibility).
4745
4846
🤝 Contribution
4947
---------------
5048

51-
check [ecoCode](https://github.com/green-code-initiative/ecoCode) repository
49+
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-contribution)
5250

5351
🤓 Main contributors
5452
--------------------
5553

56-
check [ecoCode](https://github.com/green-code-initiative/ecoCode) repository
54+
check [ecoCode repository](https://github.com/green-code-initiative/ecoCode#-main-contributors)
5755

5856
Links
5957
-----

0 commit comments

Comments
 (0)