Changeset 1301 for extensions/net.sf.basedb.reggie/trunk/README

Timestamp:

Feb 28, 2011, 11:55:08 AM (12 years ago)

Author:

Nicklas Nordborg

Message:

Updating installation instructions and packaging script.

File:

• extensions/net.sf.basedb.reggie/trunk/README (modified) (2 diffs)

extensions/net.sf.basedb.reggie/trunk/README

@@ -15 +15 @@
  1. Download the reggie-*.tar.gz file.
  2. Unpack the downloaded file to a directory of your choice.
- 3. Copy the reggie.jar file to your BASE extensions directory: 
-    WEB-INF/extensions. 
- 4. Run the 'Extensions -> Manual scan' command if you have disabled automatic
+ 3. Copy the 'reggie.jar' file and the 'lib' directory to your BASE extensions 
+    directory: WEB-INF/extensions. 
+ 4. Run the 'Extensions->Manual scan' command if you have disabled automatic
     installation. Otherwise, just wait a bit and the automatic installation will
     find and install the new extension.
- 5. Log in as a user with Administrator priviliges. Go to the Extensions -> Reggie
+ 5. Log in as a user with Administrator priviliges. Go to the Extensions->Reggie
     menu. Select the 'Verify/install required annotation types and other items'
-    wizard and create the required items.
+    wizard and create the required items. If the 'Reggie' menu is not visible
+    try BASE->Reload permissions menu.
  6. Done. 
+
+ 
+== Using ==
  
 Reggie appears as a menu entry in the Extensions menu. All operations
-are available on that page.
+are available on that page. 
+
+ * Verify/install required annotation types and other items:
+   This entry is available if the logged in user is an 'Administrator' and
+   will perform some basic checks that items that are needed by Reggie
+   exists and have been properly configured. Items that doesn't exists can
+   be created automatically.
+   
+ * Personal information registration:
+   This entry is available for 'Administrators' and members of the 
+   'PatientCurator' group. It is used to register new patients and
+   cases and connect this information to (already existing) 
+   specimen tubes.
+
 
 == Compiling ==
@@ -42 +59 @@
  2. Type `ant download-lib` to automatically download the BASE core JAR files that
     are neeed for compilation. You can also do this manually by copying the 
-    BASE2Core.jar and BASE2Webclient.jar 
+    BASE2Core.jar, BASE2Webclient.jar and BASE2WSClient.jar
     from the BASE installation directory (<basedir>/www/WEB-INF/lib/) to the 
     ./lib/compile directory.