aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorstanislavh <stanislav.honcharov@sonarsource.com>2023-01-25 11:33:13 +0100
committersonartech <sonartech@sonarsource.com>2023-01-25 20:03:04 +0000
commitcd1bd7c4a242296a973945c6f597cc0d3200c9ee (patch)
tree03a6a115dcf187cd39f5af3b20491a3c9157447a /README.md
parentc8bed350d2641b790a936c4797d44d58cf801aff (diff)
downloadsonarqube-cd1bd7c4a242296a973945c6f597cc0d3200c9ee.tar.gz
sonarqube-cd1bd7c4a242296a973945c6f597cc0d3200c9ee.zip
[NO-JIRA] Update license 2023
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 25 insertions, 32 deletions
diff --git a/README.md b/README.md
index 4aa35a6181e..da2f595c76b 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,27 @@
-SonarQube [![Build Status](https://app.travis-ci.com/SonarSource/sonarqube.svg?branch=master)](https://app.travis-ci.com/SonarSource/sonarqube) [![Quality Gate Status](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=sonarqube&metric=alert_status&token=d95182127dd5583f57578d769b511660601a8547)](https://next.sonarqube.com/sonarqube/dashboard?id=sonarqube)
-=========
+# SonarQube [![Build Status](https://app.travis-ci.com/SonarSource/sonarqube.svg?branch=master)](https://app.travis-ci.com/SonarSource/sonarqube) [![Quality Gate Status](https://next.sonarqube.com/sonarqube/api/project_badges/measure?project=sonarqube&metric=alert_status&token=d95182127dd5583f57578d769b511660601a8547)](https://next.sonarqube.com/sonarqube/dashboard?id=sonarqube)
+
+## Continuous Inspection
-Continuous Inspection
----------------------
SonarQube provides the capability to not only show health of an application but also to highlight issues newly introduced. With a Quality Gate in place, you can [Clean As You Code](https://blog.sonarsource.com/clean-as-you-code) and therefore improve code quality systematically.
-Links
------
+## Links
-* [Website](https://www.sonarqube.org)
-* [Download](https://www.sonarqube.org/downloads/)
-* [Documentation](https://docs.sonarqube.org)
-* [Twitter](https://twitter.com/SonarQube)
-* [SonarSource](https://www.sonarsource.com), author of SonarQube
-* [Issue tracking](https://jira.sonarsource.com/browse/SONAR/), read-only. Only SonarSourcers can create tickets.
-* [Responsible Disclosure](https://community.sonarsource.com/t/responsible-vulnerability-disclosure/9317)
-* [Next](https://next.sonarqube.com/sonarqube) instance of the next SonarQube version
+- [Website](https://www.sonarqube.org)
+- [Download](https://www.sonarqube.org/downloads/)
+- [Documentation](https://docs.sonarqube.org)
+- [Twitter](https://twitter.com/SonarQube)
+- [SonarSource](https://www.sonarsource.com), author of SonarQube
+- [Issue tracking](https://jira.sonarsource.com/browse/SONAR/), read-only. Only SonarSourcers can create tickets.
+- [Responsible Disclosure](https://community.sonarsource.com/t/responsible-vulnerability-disclosure/9317)
+- [Next](https://next.sonarqube.com/sonarqube) instance of the next SonarQube version
-Have Question or Feedback?
---------------------------
+## Have Question or Feedback?
For support questions ("How do I?", "I got this error, why?", ...), please first read the [documentation](https://docs.sonarqube.org) and then head to the [SonarSource Community](https://community.sonarsource.com/c/help/sq/10). The answer to your question has likely already been answered! 🤓
Be aware that this forum is a community, so the standard pleasantries ("Hi", "Thanks", ...) are expected. And if you don't get an answer to your thread, you should sit on your hands for at least three days before bumping it. Operators are not standing by. 😄
-
-Contributing
-------------
+## Contributing
If you would like to see a new feature, please create a new Community thread: ["Suggest new features"](https://community.sonarsource.com/c/suggestions/features).
@@ -38,8 +33,7 @@ Make sure that you follow our [code style](https://github.com/SonarSource/sonar-
Willing to contribute to SonarSource products? We are looking for smart, passionate, and skilled people to help us build world-class code quality solutions. Have a look at our current [job offers here](https://www.sonarsource.com/company/jobs/)!
-Building
---------
+## Building
To build sources locally follow these instructions.
@@ -52,31 +46,30 @@ Execute from project base directory:
The zip distribution file is generated in `sonar-application/build/distributions/`. Unzip it and start server by executing:
# on linux
- bin/linux-x86-64/sonar.sh start
+ bin/linux-x86-64/sonar.sh start
# or on MacOS
bin/macosx-universal-64/sonar.sh start
# or on Windows
- bin\windows-x86-64\StartSonar.bat
+ bin\windows-x86-64\StartSonar.bat
### Open in IDE
If the project has never been built, then build it as usual (see previous section) or use the quicker command:
./gradlew ide
-
+
Then open the root file `build.gradle` as a project in Intellij or Eclipse.
### Gradle Hints
-| ./gradlew command | Description |
-|---|---|
-| `dependencies`| list dependencies |
-| `licenseFormat --rerun-tasks` | fix source headers by applying HEADER.txt |
-| `wrapper --gradle-version 5.2.1` | upgrade wrapper |
+| ./gradlew command | Description |
+| -------------------------------- | ----------------------------------------- |
+| `dependencies` | list dependencies |
+| `licenseFormat --rerun-tasks` | fix source headers by applying HEADER.txt |
+| `wrapper --gradle-version 5.2.1` | upgrade wrapper |
-License
--------
+## License
-Copyright 2008-2022 SonarSource.
+Copyright 2008-2023 SonarSource.
Licensed under the [GNU Lesser General Public License, Version 3.0](https://www.gnu.org/licenses/lgpl.txt)