Changes between Version 10 and Version 11 of MolgenisApps

Timestamp:

2011-07-21T22:08:57+02:00 (13 years ago)

Author:

Morris Swertz

Comment:

--

MolgenisApps

@@ -56 +56 @@
 At every change in SVN, hudson will run clean-generate-compile-test and sent emails if errors are found.
 
+
+
+
+=== /apps ===
+Apps are applications designed to be used by an end-user. For example: /apps/xgap. 
+
+Each app is structured as follows: 
+* root package org.molgenis.<appname> contains specific sources and resourses
+* <appname>.properties file has settings for this app [move to build.xml?]
+* <appname>.testng.xml files lists all tests for this app (see hudson)
+* <appname>_ui.xml lists the user interface design for this app
+
+Developers of apps have complete freedom to do what they want within their app as other apps will ignore any code in these folders.
+
+=== /modules ===
+Modules are bundles of code that are shared between two or more apps. For example: /modules/auth.
+
+Each module is structured as follows:
+* root package org.molgenis.<modulename> contains specific sources and resourses
+* <modulename>.properties file has settings to setup a test molgenis for this module only (see hudson)
+* <modulemame>.testng.xml files lists all tests for this module (see hudson)
+* <modulename>_ui.xml lists a user interface design for this module; apps may choose to [ref] import this ui design into their application.
+
+Developers of modules are required to:
+* ensure stability of the modules by providing sufficient tests and stable programming interfaces. 
+* mark yet unstable modules with a suffix as '-dev'. For example /modules/matrix-dev. 
+* when changing an existing module copy it into a -dev version and develop on that until the code is stable before promoting it to stable
+* monitor the tests of all dependent apps on hudson and fix or undo any problems they you may have caused.
+
+=== /generated (svn:ignore) ===
+This folder contains all program resources autogenerated by the build script.
+Typically, there are:
+* /java -- generated java
+* /python -- generated python
+* /cpp -- generated c++ code
+
+NB: this folder is never committed to SVN (svn:ignore).
+=== /WebContent ===
+All resources for the web, such as images, css and javascript, can be stored in /WebContent. 
+Each app or module will create subfolders. For example:
+
+* /res -- contains resource files that are created by hand
+  * /css -- contains css files
+    * /xgap -- contains xgap specific css files
+  * /img -- contains images
+    * /xgap -- contains xgap specific css files
+  * /scritps -- contains scripts.
+    * /xgap -- contains xgap specific css files
+* /generated-res -- contains generator produced resource files (svn:ignore).
+
+=== /dist (svn:ignore) ===
+
+This folder contains all resources produced by the build script.
+This includes:
+
+* /dist/classes -- all compiled class files and copy of *.property and *.ftl files
+* /dist/test-output -- result of the tests
+* /dist/javadoc -- generated javadoc for your app
+* /dist/<name>.war -- generated war for deployment on tomcat and mysql
+* /dist/<name>.jar -- generated jar for standalone running of the app
+
 == Creating a new app ==
 
@@ -93 +154 @@
 
 
-=== /apps ===
-Apps are applications designed to be used by an end-user. For example: /apps/xgap. 
-
-Each app is structured as follows: 
-* root package org.molgenis.<appname> contains specific sources and resourses
-* <appname>.properties file has settings for this app [move to build.xml?]
-* <appname>.testng.xml files lists all tests for this app (see hudson)
-* <appname>_ui.xml lists the user interface design for this app
-
-Developers of apps have complete freedom to do what they want within their app as other apps will ignore any code in these folders.
-
-=== /modules ===
-Modules are bundles of code that are shared between two or more apps. For example: /modules/auth.
-
-Each module is structured as follows:
-* root package org.molgenis.<modulename> contains specific sources and resourses
-* <modulename>.properties file has settings to setup a test molgenis for this module only (see hudson)
-* <modulemame>.testng.xml files lists all tests for this module (see hudson)
-* <modulename>_ui.xml lists a user interface design for this module; apps may choose to [ref] import this ui design into their application.
-
-Developers of modules are required to:
-* ensure stability of the modules by providing sufficient tests and stable programming interfaces. 
-* mark yet unstable modules with a suffix as '-dev'. For example /modules/matrix-dev. 
-* when changing an existing module copy it into a -dev version and develop on that until the code is stable before promoting it to stable
-* monitor the tests of all dependent apps on hudson and fix or undo any problems they you may have caused.
-
-=== /generated (svn:ignore) ===
-This folder contains all program resources autogenerated by the build script.
-Typically, there are:
-* /java -- generated java
-* /python -- generated python
-* /cpp -- generated c++ code
-
-NB: this folder is never committed to SVN (svn:ignore).
-
-
-=== /WebContent ===
-All resources for the web, such as images, css and javascript, can be stored in /WebContent. 
-Each app or module will create subfolders. For example:
-
-* /res -- contains resource files that are created by hand
-  * /css -- contains css files
-    * /xgap -- contains xgap specific css files
-  * /img -- contains images
-    * /xgap -- contains xgap specific css files
-  * /scritps -- contains scripts.
-    * /xgap -- contains xgap specific css files
-* /generated-res -- contains generator produced resource files (svn:ignore).
-
-=== /dist (svn:ignore) ===
-
-