Refactored and reviewed documentation

siren-parent/BUILD.txt → BUILD.txt

@@ -32,28 +32,28 @@ releases are available for download from:
 Download the tarred/gzipped version of the archive, and
 uncompress it into a directory of your choice.
 
-Step 2) From the command line, change (cd) into the parent module directory, 
-i.e., siren-parent, of your SIREn installation
+Step 2) From the command line, change (cd) into the directory of your SIREn
+installation
 
-SIREn's parent module directory contains the parent pom.xml file. By default,
+SIREn's installation directory contains the project pom.xml file. By default,
 you do not need to change any of the settings in this file, but you do
 need to run maven from this location so it knows where to find pom.xml.
 
 Step 3) Run maven
 
 Assuming you have maven in your PATH, typing "mvn package" at the shell prompt
 and command prompt should run maven. Maven will by default look for the
-"pom.xml" files in the sub-modules (siren-core, siren-qparser and siren-solr), 
+"pom.xml" files in the sub-modules (siren-core, siren-qparser and siren-solr),
 compile them and run the tests.
 
-The SIREn jar file will be located at "./target/siren-#{version}.jar".
+The SIREn jar file will be located at "#{sub-module}/target/siren-#{version}.jar".
 
-You might want also to install them into your local maven repository by typing 
+You might want also to install them into your local maven repository by typing
 "mvn install".
 
-To generate the javadoc, you should type "mvn javadoc:javadoc" at the shell 
-prompt. Maven will generate the javadoc API in the directory 
-"./target/site/apidocs/".
+To generate the javadoc, you should type "mvn javadoc:javadoc" at the shell
+prompt. Maven will generate the javadoc API in the directory
+"#{sub-module}/target/site/apidocs/".
 
 --------------------------------------------------------------------------------
 
@@ -69,16 +69,17 @@ Please join the SIREn-User mailing list by visiting this site:
   http://lists.deri.org/mailman/listinfo/siren
 
 Please post suggestions, questions, corrections or additions to this
-document to the lucene-user mailing list.
+document to the siren-user mailing list.
 
 --------------------------------------------------------------------------------
 
 This file was originally written by Steven J. Owens <[email protected]> for
-Lucene, and has been modified by Renaud Delbru <[email protected]> for 
+Lucene, and has been modified by Renaud Delbru <[email protected]> for
 SIREn.
 
 Copyright (c) 2010, 2011
 Renaud Delbru,
 Digital Enterprise Research Institute,
-National University of Ireland, Galway.  
+National University of Ireland, Galway.
 All rights reserved.
+

siren-parent/NOTICE.txt → NOTICE.txt

@@ -1,6 +1,6 @@
 ==============================================================
  SIREn
- Copyright 2010
+ Copyright 2010, 2011
  Digital Enterprise Research Institute,
  National University of Ireland, Galway
 ==============================================================
@@ -24,8 +24,7 @@ must include the following acknowledgement:
 Alternately, this acknowledgement may appear in the software itself,
 if and wherever such third-party acknowledgements normally appear.
 
-The names "SIREn" must not be used to endorse or promote products derived 
-from this software without prior written permission. For written permission, 
+The names "SIREn" must not be used to endorse or promote products derived
+from this software without prior written permission. For written permission,
 please contact Renaud Delbru ([email protected]).
 
-

README.txt

@@ -0,0 +1,60 @@
+SIREn README file
+====================
+
+Provide efficient semi-structured based searching to Lucene / Solr
+
+Author: Renaud Delbru
+email: [email protected]
+
+Author: Stephane Campinas
+email: [email protected]
+
+Author: Nickolai Toupikov
+email: [email protected]
+
+Author: Robert Fuller
+email: [email protected]
+
+--------------------------------------------------------------------------------
+
+INTRODUCTION
+============
+
+Efficient, large scale handling of semi-structured data (including RDF) is
+increasingly an important issue to many web and enterprise information reuse scenarios.
+
+While Lucene has long offered these capabilities, its native capabilities are
+not intended for large semi-structured document collections (or documents with
+very different schemas). For this reason we developed SIREn - Semantic
+Information Retrieval Engine - a Lucene/Solr plugin to overcome these shortcomings
+and efficiently index and query RDF, as well as any textual document with an
+arbitrary amount of metadata fields.
+
+SIREn is a Lucene/Solr extension for effificent semi-structured full-text search.
+SIREn is not a complete application by itself, but rather a code library and API
+that can easily be used to create a full-featured semi-structured search engine.
+
+--------------------------------------------------------------------------------
+
+RESOURCES
+=========
+
+The SIREn web site is at:
+  http://siren.sindice.com/
+
+You can download SIREn at:
+  https://github.com/rdelbru/SIREn
+
+Please join the SIREn-User mailing list by subscribing at:
+  http://lists.deri.org/mailman/listinfo/siren
+
+--------------------------------------------------------------------------------
+
+This file was written by Renaud Delbru <[email protected]> for SIREn.
+
+Copyright (c) 2010, 2011
+Renaud Delbru,
+Digital Enterprise Research Institute,
+National University of Ireland, Galway.
+All rights reserved.
+

siren-core/README.txt

@@ -1,53 +1,44 @@
-SIREn README file
-====================
+SIREn Core README file
+======================
 
-Provide semi-structured based searching to lucene in an efficient manor
+Provide efficient semi-structured based searching to Lucene
 
 Author: Renaud Delbru
 email: [email protected]
 
+Author: Stephane Campinas
+email: [email protected]
+
 Author: Nickolai Toupikov
 email: [email protected]
 
 Author: Robert Fuller
 email: [email protected]
 
-====================
-
-INTRODUCTION
-
-SIREn is a Java semi-structured full-text search engine based on Lucene. 
-SIREn is not a complete application, but rather a code library and API that can 
-easily be used to add semi-structured search capabilities to applications.
-
-The SIREn web site is at:
-  http://siren.sindice.com/
-
-Please join the SIREn-User mailing list by subscribing at:
-  http://lists.deri.org/mailman/listinfo/siren
-
-====================
+--------------------------------------------------------------------------------
 
 FILES
+=====
 
 src/main/java
   The SIREn source code.
-  
+
 src/main/jflex
   The SIREn JFlex source code.
-  
+
 src/test/java
   The SIREn unit tests.
 
 src/test/java/org/sindice/siren/demo/
   Some example code.
-  
+
 --------------------------------------------------------------------------------
 
 This file was written by Renaud Delbru <[email protected]> for SIREn.
-  
+
 Copyright (c) 2010, 2011
 Renaud Delbru,
 Digital Enterprise Research Institute,
-National University of Ireland, Galway.  
+National University of Ireland, Galway.
 All rights reserved.
+