-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Sshorten the README. Avoid duplications and complicated sentences. * Add checkstyle logo to have some graphics. * Add license. * Move contribution instructions to separate file.
- Loading branch information
1 parent
74af9a9
commit 66e41bf
Showing
2 changed files
with
30 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Contributing | ||
|
|
||
| * [Reporting issues](https://github.com/checkstyle/eclipse-cs/issues) | ||
|
|
||
| ## Building | ||
|
|
||
| * Clone the git repository. | ||
| * Import all projects into your Eclipse workspace. | ||
| * Run `mvnw package` in the root folder to build, test and package. | ||
| * Find the installable bundle update site at `net.sf.eclipsecs-updatesite/target/net.sf.eclipsecs-updatesite_X.X.X.YYYYmmDDHHMM.zip`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,31 @@ | ||
| # eclipse-cs | ||
| The Eclipse Checkstyle plug-in integrates the Checkstyle Java code auditor into the Eclipse IDE. | ||
| The plug-in provides real-time feedback to the user about violations of rules that | ||
| check for coding style and possible error prone code constructs. | ||
| #  | ||
|
|
||
| [Checkstyle](https://github.com/checkstyle/checkstyle) is an Open Source development tool to help you ensure that your Java code adheres to a set of coding standards. Checkstyle does this by inspecting your Java source code and pointing out items that deviate from a defined set of coding rules. | ||
| # Eclipse Checkstyle | ||
|
|
||
| ### Install | ||
| You can install the latest version of the plugin from the Eclipse Marketplace. | ||
| - Go to Help->Eclipse Marketplace... | ||
| - Search for "Checkstyle" or "Checkstyle Plug-in". Look for the eclipse-cs plugin. | ||
| - Click "Install". | ||
| The Eclipse Checkstyle plug-in integrates [Checkstyle](https://github.com/checkstyle/checkstyle) into the Eclipse IDE. | ||
| It provides real-time feedback about violations of your coding standards. | ||
|
|
||
| ## Installation | ||
|
|
||
| You can install the latest version of the plugin from the [Eclipse Marketplace](https://marketplace.eclipse.org/content/checkstyle-plug). | ||
| - In Eclipse, use Help->Eclipse Marketplace... | ||
| - Search for "Checkstyle" or "Checkstyle Plug-in". | ||
| - Click "Install" next to the matching search result. | ||
|
|
||
| If you need to install an older version: | ||
| - Go to Help->Install New Software... | ||
| - If Eclipse does not yet know about the Checkstyle repository, you need to add it. Click "Add..." to add a new repository. | ||
| - Click "Add..." to add a new repository. | ||
| - Name: Checkstyle | ||
| - Location: https://checkstyle.org/eclipse-cs-update-site/ | ||
| - Make sure that the Checkstyle repository has been selected from the dropdown. | ||
| - Make sure that "Show only the latest versions of available software" is unchecked. | ||
| - You should now see the available versions of the Checkstyle plugin from which you can select and install. | ||
|
|
||
| ### What does it do? | ||
| With the Checkstyle Eclipse Plugin your code is constantly inspected for coding standard deviations. Within the Eclipse workbench you are immediately notified of problems via the Eclipse Problems View and source code annotations similar to compiler errors or warnings. | ||
| This ensures an extremely short feedback loop right at the developers fingertips. | ||
| - Afterwards select the Checkstyle repository from the dropdown. | ||
| - Uncheck "Show only the latest versions of available software". | ||
| - Select any of the available versions of the Checkstyle plugin and install. | ||
|
|
||
| ### Why would I use it? | ||
| If your development team consists of more than one person, then obviously a common ground for coding standards (formatting rules, line lengths etc.) must be agreed upon - even if it is just for practical reasons to avoid superficial, format related merge conflicts. | ||
| Checkstyle (and the Eclipse Checkstyle Plugin for that matter) helps you define and easily apply those common rules. | ||
| ## Contributing | ||
|
|
||
| ### Build it yourself | ||
| Clone the git repository (or create a fork) and import all projects into your Eclipse workspace. | ||
| Learn [how to get started](CONTRIBUTING.md). | ||
| Please adhere to this project's [code of conduct](CODE_OF_CONDUCT.md). | ||
|
|
||
| Open a command line in project root directory and run `./mvnw clean package`. | ||
| ## License | ||
|
|
||
| Find the installable bundle update site archive `net.sf.eclipsecs-updatesite/target/net.sf.eclipsecs-updatesite_X.X.X.YYYYmmDDHHMM.zip`. | ||
| This project is licensed under [LGPL 2.1](LICENSE). |