Google Git
Sign in
apache / lucenenet / pcl
commitecf03e102d656e4a2c193d6ca2dc7333e32f3d21[log] [tgz]
authorMichael Herndon <mherndon@michaelherndon.com>Sun Nov 09 17:06:09 2014 -0500
committerMichael Herndon <mherndon@michaelherndon.com>Sun Nov 09 17:06:09 2014 -0500
treed14f330c1cf71f5c35c4115f88f76280f1267a0a
parentd90ecf3f6690fddd60f021a91b6cac30066c71a6 [diff]
updating readme
1 file changed
tree: d14f330c1cf71f5c35c4115f88f76280f1267a0a
  1. .nuget/
  2. docs/
  3. src/
  4. test/
  5. .gitignore
  6. ACKNOWLEDGEMENTS.txt
  7. build.cmd
  8. build.fsx
  9. build.sh
  10. global.json
  11. LICENSE.txt
  12. Lucene.sln
  13. Lucene.vs2013.sln
  14. Lucene.vs2013.sln.DotSettings
  15. Lucene.vs2013.sln.GhostDoc.user.dic
  16. Lucene.vs2013.sln.GhostDoc.xml
  17. NOTICE.txt
  18. NuGet.Config
  19. README.md
  20. resharper.DotSettings
README.md

Apache Lucene.Net For KLR / PCL

INTRODUCTION

This branch is an experimental version of LUCENE.NET being built with Visual Studio 14 for PCL, portable class libraries, and the K10 / KLR (K or cloud Language Runtime for .NET. There will be breaking change and porting to PCL will be challenging. If you're up for a challenge, please contribute.

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

NOTICE

This branch is on hiatus as I‘m currently working on extending Xunit.Net to have similar functionality to JUnit for TestRules and to enable randomization testing from carrot search. I’m also working on making the story for running tests quickly from the command line.

I've also started separate code that provides the same apis found in Java but .Net into a separate library in hopes that it will make it easier for others to port code from Java.

The Mettle Project can be found here:

  • Michael

Getting Started

Windows Users

Contributing Back

Articles

Submit any articles and tutorials to the developers list, dev @ lucenenet.apache.org.

Contributing Code For Lucene.Net 5.0 PCL Branch

  • The current branch that is being ported is master on lucene-solr. This will change to a tag in the future.
  • Create a task issue in Jira
    • Add the label patch
    • Set the affects version Lucene.Net 5.0 PCL
    • State the intended work.
    • Acknowledge that the code in the pull request is licensed under Apache 2.0 and the work is not copied. If it is copied, it must be under an apache 2 compatible license and the license must be in the code.
  • Follow the internal Micrsoft code style guides.
  • Make sure to submit tests and document public code. Use code comments to explain decisions.
    • If the pull request lacks tests and documentation, it will take longer for the commiters to adjust and merge the code to make it available for everyone.
    • Contributing something is better than nothing. Maybe another contributor will take the patch / pull request and complete it.
  • Put the ticket number in commit messages. i.e. LUCENENET-168
  • Send a pull request with the ticket number to github.
  • See Also: Contributor's Guide

Running Tests

  • open a command line tool
  • change the directory to the test project that you wish to run.
  • run the command $ k test

example

$ cd path/to/lucene.net/tests/Lucene.Net.Core.Tests
$ k test

Build Scripts

Milestone 1

  • Implement Build Scripts with Fake
    • Crossplatform Support.
    • Easier than using XML.
  • Implement a ci server, possibly appveyor
  • Generate Code Documentation.
  • Port core, test-framework, and tests for core.

Notes

  • *.csproj files exist for the PCL version because the RuntimeMetadataVersion is not found. Once this issue is resolved, those files will be removed.