Moved README.txt from eclipse/settings/code-style to eclipse/ and expanded it to cover workspace variables, spelling dictionary, and project importing. It is now a general-purpose "How to setup Eclipse" document instead of just focusing on code style.
Also fixed gwt-dev-mac's checkstyle settings.
git-svn-id: https://google-web-toolkit.googlecode.com/svn/trunk@181 8db76d5a-ed1c-0410-87a9-c151d255dfc7
diff --git a/eclipse/README.txt b/eclipse/README.txt
new file mode 100644
index 0000000..6baf33d
--- /dev/null
+++ b/eclipse/README.txt
@@ -0,0 +1,60 @@
+Eclipse 3.2.X instructions
+
+---------- Required GWT variables ---------
+
+Window->Preferences->General->Workspace->Linked Resources
+Create a variable named "GWT_ROOT" pointing to your"trunk" folder.
+
+Window->Preferences->Java->Build Path->Classpath Variables
+Create a variable named "GWT_TOOLS" pointing to your"tools" folder.
+
+---------------- Spelling -----------------
+
+Window->Preferences->Editors->Text Editors->Spelling
+Enable spell checking, use "settings/english.dictionary".
+
+---------- Code style/formatting ----------
+
+Window->Preferences->Java->Code Style->Formatter->Import...
+settings/code-style/gwt-format.xml
+
+----------- Import organization -----------
+
+Window->Preferences->Java->Code Style->Organize Imports->Import...
+settings/code-style/gwt.importorder
+
+------------ Member sort order ------------
+
+Window->Preferences->Java->Appearance->Members Sort Order
+There is no import here, make your settings match:
+settings/code-style/gwt-sort-order.png
+
+
+--------------- Checkstyle ----------------
+
+1. Checkstyle is used to enforce good programming style. The Eclipse Checkstyle
+plugin can be found at:
+
+ http://eclipse-cs.sourceforge.net/
+
+2. Importing the GWT Checkstyle configuration:
+
+Window->Preferences->Checkstyle->New...
+Set the Type to "External Configuration File"
+Set the Name to "GWT Checks" (important)
+Set the location to "settings/code-style/gwt-checkstyle.xml".
+Suggested: Check "Protect Checkstyle configuration file".
+Click "Ok".
+
+3. Enabled Custom GWT Checkstyle checks:
+
+Copy "settings/code-style/gwt-customchecks.jar" into:
+ <eclipse>/plugins/com.atlassw.tools.eclipse.checkstyle_x.x.x/extension-libraries
+
+("gwt-customchecks.jar" is also built from source into build/lib during a full build)
+
+4. Enable Checkstyle for each project:
+
+Package Explorer->Project Name->Preferences->Checkstyle
+Check Checkstyle active for this project, the rest of the configuration should
+be already loaded.
diff --git a/eclipse/dev/mac/.checkstyle b/eclipse/dev/mac/.checkstyle
index 1d83316..cd3e324 100644
--- a/eclipse/dev/mac/.checkstyle
+++ b/eclipse/dev/mac/.checkstyle
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<fileset-config file-format-version="1.2.0" simple-config="false">
- <fileset name="all" enabled="true" check-config-name="GWT Checkstyle Rules" local="false">
+ <fileset name="all" enabled="true" check-config-name="GWT Checks" local="false">
<file-match-pattern match-pattern=".*core.src.com.google.gwt.*java" include-pattern="true"/>
<file-match-pattern match-pattern=".*rhino.*" include-pattern="false"/>
<file-match-pattern match-pattern=".*mac.src.com.google.gwt.*java" include-pattern="true"/>
diff --git a/eclipse/settings/code-style/README.txt b/eclipse/settings/code-style/README.txt
deleted file mode 100644
index f781578..0000000
--- a/eclipse/settings/code-style/README.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-Eclipse 3.2.X instructions
-
-Code style/formatting:
-Window->Preferences->Java->Code Style->Formatter->Import...
-gwt-format.xml
-
-Import organization:
-Window->Preferences->Java->Code Style->Organize Imports->Import...
-gwt.importorder
-
-Member sort order:
-Window->Preferences->Java->Appearance->Members Sort Order
-There is no import here, make your settings match gwt-sort-order.png
-
-Checkstyle:
-1. Checkstyle is used to enforce good programming style. The Eclipse Checkstyle
-plugin can be found at: http://eclipse-cs.sourceforge.net/.
-
-2. Importing the GWT Checkstyle configuration:
-Window->Preferences->Checkstyle->New...
-Set the Type to "External Configuration File"
-Set the Name to "GWT Checks"
-Set the location to the "gwt-checkstyle.xml" in this directory.
-Click "Ok".
-
-3. Enabled Custom GWT Checkstyle checks:
-After building GWT, a "gwt-customchecks.jar" is created in build/lib.
-Copy this jar into:
- <eclipse>/plugins/com.atlassw.tools.eclipse.checkstyle_x.x.x/extension-libraries
-
-
-4. Enable Checkstyle for each project:
-Package Explorer-> Project Name -> Preferences->Checkstyle
-Check Checkstyle active for this project, the rest of the configuration should
-be already loaded.
