lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject lucenenet git commit: Updated README.md with links to NuGet, issue tracker, Java API documentation, Wiki, Mailing Lists as well as Status, Contributing, and Build information
Date Thu, 06 Apr 2017 14:43:42 GMT
Repository: lucenenet
Updated Branches:
  refs/heads/api-work 240a6bfa5 -> 4be95930a


Updated README.md with links to NuGet, issue tracker, Java API documentation, Wiki, Mailing
Lists as well as Status, Contributing, and Build information


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/4be95930
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/4be95930
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/4be95930

Branch: refs/heads/api-work
Commit: 4be95930ac7370a4c7fa7ee700982bf10e9ae9c8
Parents: 240a6bf
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Thu Apr 6 19:46:09 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Thu Apr 6 21:38:42 2017 +0700

----------------------------------------------------------------------
 README.md | 106 +++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 85 insertions(+), 21 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4be95930/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index afbdb53..b9b4e37 100644
--- a/README.md
+++ b/README.md
@@ -2,35 +2,99 @@
 
 Apache Lucene.Net is a C# full-text search engine, a C# port of the popular Apache Lucene
project.  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.5
-
 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
+## Supported Frameworks
+
+### Lucene.Net 4.8.0
+
+- .NET Standard 1.5
+- .NET Framework 4.5.1
+
+### Lucene.Net 3.0.3
+
+- .NET Framework 4.0
+- .NET Framework 3.5
 
-*** This is the main branch where development happens, please don't use any other branches
unless you know what you are doing! ***
+## Status
 
-## Files
+Latest Stable Version: Lucene.Net 3.0.3
 
-src/Contrib
-  Temporary folder, mainly contributed code whihc extends and enhances Apahce Lucene.Net,
but is not part of the core library
-  
-src/Lucene.Net.*
-  Lucene.NET sub-projects (Core, Queries, Analysis, Facet, etc)
+Working toward Lucene.Net 4.8.0 (currently in BETA)
 
-src/Lucene.Net.TestFramework
-  A TestFramework class library which provides a lot of support code for the various Tests
projects.
+## Download
 
-src/Lucene.Net.Tests.*
-  Tests for Lucene.NET sub-projects
+[![NuGet version](https://badge.fury.io/nu/Lucene.Net.svg)](https://www.nuget.org/packages/Lucene.Net/)
+
+```
+PM> Install-Package Lucene.Net
+```
+
+Lucene.Net is now divided into several sub-packages. See the [complete list of Lucene.Net
sub-packages on NuGet.org](https://www.nuget.org/packages?q=lucene.net)
+
+Our [continuous integration feed](https://myget.org/gallery/lucene-net) is available on MyGet,
for those who want to live on the edge.
 
 ## Documentation
 
-MSDN style API documentation for Apache Lucene.Net exists.  Those can be found at this site:
-  http://incubator.apache.org/lucene.net/docs/2.9.4/Index.html
-  
-  or 
-  
-  http://incubator.apache.org/lucene.net/docs/2.9.4/Lucene.Net.chm
\ No newline at end of file
+[Lucene.Net WIKI](https://cwiki.apache.org/confluence/display/LUCENENET/Lucene.Net)
+
+We don't yet have API documentation for Lucene.Net 4.8.0 (contributions welcome), but the
API is similar to [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/).
+
+### Legacy Versions
+
+- [Lucene.Net 3.0.3 API Documentation](http://incubator.apache.org/lucene.net/docs/3.0.3/Index.html)
+- [Lucene.Net 2.9.4 API Documentation](http://incubator.apache.org/lucene.net/docs/2.9.4/Index.html)
+
+## How to Contribute
+
+Lucene is a very large project (over 350,000 executable lines of code) and we welcome any
and all help to maintain such an effort.
+
+### Join Mailing Lists
+
+[How to Join/Unsubscribe to/from mailing lists](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists)
+
+### Ask a Question
+
+If you have a general how-to question or need help from the Lucene.Net community, please
email the Apache Lucene.Net-User mailing list by sending a message to:
+
+[user@lucenenet.apache.org](mailto:user@lucenenet.apache.org)
+
+We recommend you join the [user mailing list](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists)
to stay looped into all user discussions.
+
+### Report a Bug
+
+To report a bug, please use the [JIRA issue tracker](https://issues.apache.org/jira/browse/LUCENENET-574?jql=project%20%3D%20LUCENENET%20AND%20status%20%3D%20Open).
You can signup for a JIRA account [here](https://cwiki.apache.org/confluence/signup.action)
(it just takes a minute).
+
+### Start a Discussion
+
+To start a development discussion regarding technical features of Lucene.Net, please email
the Apache Lucene.Net-Developer mailing list by sending a message to: 
+
+[dev@lucenenet.apache.org](mailto:dev@lucenenet.apache.org)
+
+We recommend you join both the [user and dev mailing lists](https://cwiki.apache.org/confluence/display/LUCENENET/Mailing+Lists)
to stay looped in to all user and developer discussions.
+
+### Submit a Pull Request
+
+Before you start working on a pull request, please read our [Contributing](https://github.com/apache/lucenenet/blob/master/CONTRIBUTING.md)
guide.
+
+If you plan to submit multiple pull requests, please submit an [Individual Contributor License](https://cwiki.apache.org/confluence/display/LUCENENET/Individual+Contributor+License),
or for individual pull requests, just submit the request and in the description state that
the code is your original work and you license it under the [Apache License v2](http://www.apache.org/licenses/LICENSE-2.0).
+
+## Build
+
+To build the source, clone or download the repository. From the repository root, execute:
+
+```
+> build -pv:4.8.0.1000
+```
+
+This will build, version, and create NuGet `.nupkg` packages in the directory `/src/release/NuGetPackages/`.
You can setup Visual Studio to read these packages like any NuGet feed by following these
steps:
+
+1. In Visual Studio, right-click the solution in Solution Explorer, and choose "Manage NuGet
Packages for Solution"
+2. Click the gear icon next to the Package sources dropdown.
+3. Click the `+` icon (for add)
+4. Give the source a name such as `Lucene.Net Local Packages`
+5. Click the `...` button next to the Source field, and choose the `/src/release/NuGetPackages`
folder on your local system.
+6. Click Ok
+
+Then all you need to do is choose the `Lucene.Net Local Packages` feed from the dropdown
(in the NuGet Package Manager) and you can search for, install, and update the NuGet packages
just as you can with any Internet-based feed.


Mime
View raw message