[SCM] Lisaac eclipse plugin branch, master, updated. a72571f805c203ff87686bc23d5818d7bc65d53b

[Damien Bouvarel]

The following commit has been merged in the master branch:
commit 07221a127f5fb71c24640f0f187be4b0e370ef47
Author: Damien Bouvarel <dams.bouvarel at wanadoo.fr>
Date:   Mon Mar 23 20:45:00 2009 +0100

    update README

diff --git a/README b/README
index e69de29..e0cabc1 100644
--- a/README
+++ b/README
@@ -0,0 +1,86 @@
+   ------------------------------------
+        Lisaac Eclipse plugin.          ** Unstable version **
+   ------------------------------------
+
+How to get started?
+===================
+
+ * Plugin Development :
+    --------------------------
+    
+    - Install latest Eclipse SDK (3.4 Ganymede)  see http://www.eclipse.org/downloads.
+    - Switch your workspace to the 'eclipse' *parent* directory. (File->Switch Workspace->Other)  ex:  /.../myWorkspace/eclipse/...
+    - Create a Project (File->New->Project, select General->Project).
+    - Enter project name: 'eclipse'  and click on the finish button.
+        or
+    - Select your own workspace and create a project with 'eclipse' lisaac plugin location.
+        or 
+    - Import the 'eclipse' project (File->Import then select 'Existing Projects into Workspace').
+    
+    - First Run : open META-INF/MANIFEST.MF and click on the link 'Launch an Eclipse application'.
+    - Other Run :   Green toolbar button  Run->EclipseApplication or Run->Run As->EclipseApplication
+    
+    - Install git plugin:  Help->Software Updates, in Available software tab click 'Add site...' and enter update site: http://www.jgit.org/update-site/  check 'Release Build' and click 'Install'.
+    - Right-click on project in navigator view,  select Team->Share Project, then select 'Git'.
+    - For Git operations: right-click, select Team->... 
+    
+  * Plugin Installation :
+     -------------------
+ 
+    (not released yet)
+   
+Quick Start into Source Code.
+===================
+ 
+   * General overview:
+      -----------------------
+      
+   - META-INF/MANIFEST.MF               Main file for Plugin general settings -  edit within eclipse only.
+   - plugin.xml                                    Define Extensions Points that the plugin implements - edit within eclipse only.
+   - build.properties                           Define Plugin classpath for compilation - edit within eclipse only.
+   
+   - .project & .classpath & .settings  Eclipse files associated with the project - you may erase or replace them.       
+   
+   - src/                                               Java implementation.
+   - help/                                             Help files used inside lisaac plugin, html doc (Help->Help contents) and sheetcheats (Help->Cheat Sheets...)
+   - icons/                                            Icons used in lisaac plugin.
+   - bin/                                               Java binary files (removed in git repository) This is automatically placed in jar file while releasing.
+   
+   * Java Packages overview
+     -------------------------------
+     
+     - lisaac/                                         Main package, contain plugin activator, LisaacPlugin.java, this object follows plugin lifecycle.
+     - lisaac/actions                              Plugin menus actions, which implements IActionDelegate interface.
+     - lisaac/builder                              Incremental project builder - Handle calls to create & update Lisaac Models for each lisaac project.
+     - lisaac/editors                              Lisaac and Lip Editor. Handle syntax coloring, completion, hyperlinks...
+     - lisaac/launch                               Interface to call Lisaac Compiler and lisaac tools - Manage Lisaac Run Configuration (Run->Run configurations...)
+     - lisaac/model                                Manage and Parse Lisaac Models - Used by completion, colorer, hyperlinks, run...
+     - lisaac/model/items                      Parsing element of lisaac syntax tree. 
+     - lisaac/model/lip                           Parsing element of lip syntax tree. 
+     - lisaac/model/types                      Parsing types of lisaac syntax tree.
+     - lisaac/outline                              Elements displayed in Lisaac Outline view.
+     - lisaac/perspectives                     Define Lisaac Perspective.
+     - lisaac/preferences                      Add menus to Window->Preferences Menu in Lisaac section. 
+     - lisaac/properties                         Add menus to right-click Properties Menu for lisaac resources.
+     - lisaac/views                                Define Lisaac Views, Console, Outline view, ...
+     - lisaac/wizards                             Define Lisaac Wizards, New Lisaac Project, New Prototype, ...
+    
+    
+     more to come...
+   
+   
+   * Tips
+      -----
+ 
+     - Consider using 'Debug->Eclipse Application' and double click at the left margin to set breakpoints.
+     - Ctrl+click to explore Eclipse Java classes.
+     - Think at java search and java refactoring.
+     - use TODO tag and open task view (Window->Show View).
+     - when a file is 'Out of Sync' select 'Refresh' Menu in eclipse navigator.
+     - Delete your eclipse .metadata (in workspace root) when its getting too big.
+     - Project->Clean  when eclipse get confused.
+     
+   --
+   Best regards,
+    Damien Bouvarel <Damien.Bouvarel at bvra.e.ujf-grenoble.fr>
+    The Lisaac team.

-- 
Lisaac eclipse plugin