README.txt

Apache Lucene.Net README file


INTRODUCTION
-------------
Apache Lucene.Net is a C# full-text search engine.  Apache Lucene.Net is not a complete application, 
but rather a code library and API that can easily be used to add search capabilities to applications.

Apache Lucene.Net is compiled against Microsoft .NET Framework 4.0

The Apache Lucene.Net web site is at:
  http://lucenenet.apache.org

Please join the Apache Lucene.Net-User mailing list by sending a message to:
  user-subscribe@lucenenet.apache.org


CURRENT WORK
---------------
The Lucene.NET committers and community are currently working on a version 4.3 port of Lucene that can be found in branch_4x of the git repository.  

The apache source code for Lucene.Net can be found here:
https://git-wip-us.apache.org/repos/asf/lucenenet.git




FILES
---------------
build/scripts
  Build scripts
  
build/*
  Visual Studio solution files
 
src/Contrib
  Contributed code whihc extends and enhances Apahce Lucene.Net, but is not part of the core library
  
src/core
  The Lucene source code.

src/Demo
  Some example code.

test/*
  nUnit tests for Lucene.Net and Contrib projects

DOCUMENTATION
---------------------
MSDN style API documentation for Apache Lucene.Net exists.  Those can be found at this site:
  http://lucenenet.apache.org/docs/3.0.3/Index.html
  
  or 
  
  http://lucenenet.apache.org/docs/3.0.3/Lucene.Net.chm
  
ADDITIONAL LIBRARIES
-----------------------------
There are a number of additional libraries that various parts of Lucene.Net may depend. These are not 
included in the source distribution

These libraries can be found at:
	https://svn.apache.org/repos/asf/lucene.net/tags/Lucene.Net_3_0_3_RC1/lib/
	
Libraries:
	- Gallio 3.2.750
	- ICSharpCode
	- Nuget
	- NUnit.org
  - Spatial4n
	- StyleCop 4.5