lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [lucenenet] 06/09: Updated README with lucene-cli info
Date Fri, 09 Aug 2019 19:50:07 GMT
This is an automated email from the ASF dual-hosted git repository.

nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git

commit 3606b914b8fbec7c3d546c298721e6141605eea2
Author: Shad Storhaug <shad@shadstorhaug.com>
AuthorDate: Fri Aug 9 21:12:15 2019 +0700

    Updated README with lucene-cli info
---
 README.md                                 | 21 ++++++++++++++++-----
 src/dotnet/tools/lucene-cli/docs/index.md |  4 ++--
 2 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 4ce4667..ff17d89 100644
--- a/README.md
+++ b/README.md
@@ -86,12 +86,10 @@ PM> Install-Package Lucene.Net -Pre
 - [Lucene.Net.Replicator](https://www.nuget.org/packages/Lucene.Net.Replicator/)  Files replication
utility
 - [Lucene.Net.Sandbox](https://www.nuget.org/packages/Lucene.Net.Sandbox/) - Various third
party contributions and new ideas
 - [Lucene.Net.Spatial](https://www.nuget.org/packages/Lucene.Net.Spatial/) - Geospatial search
-- [Lucene.Net.Suggest](https://www.nuget.org/packages/Lucene.Net.Suggest/) - Auto-suggest
and Spellchecking support
+- [Lucene.Net.Suggest](https://www.nuget.org/packages/Lucene.Net.Suggest/) - Auto-suggest
and Spell-checking support
 
 ## Documentation
 
-[Lucene.Net WIKI](https://cwiki.apache.org/confluence/display/LUCENENET/Lucene.Net)
-
 We now have some preliminary documentation for Lucene.Net 4.8.0 [on the Lucene.Net Website](https://lucenenet.apache.org/).
 
 The API is similar to Java [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/), which you
may also find helpful to review.
@@ -103,10 +101,23 @@ The API is similar to Java [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/)
 - [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)
 
-## Demos
+## Demos & Tools
 
 There are several demos implemented as simple console applications that can be copied and
pasted into Visual Studio or compiled on the command line in the [Lucene.Net.Demo project](https://github.com/apache/lucenenet/tree/master/src/Lucene.Net.Demo).
 
+<!-- TO BE ADDED WHEN RELEASED
+
+There is also a dotnet command line tool available on NuGet. It contains all of the demos
as well as tools maintaining your Lucene.Net index, containing such operations as splitting,
merging, listing segment info, fixing, deleting segments, upgrading, etc. Always be sure to
back up your index before running any commands against it!
+
+```
+dotnet tool install lucene-cli -g --version 4.8.0-beta00006
+```
+
+Once installed, you can explore what commands and options are available by entering the command
`lucene`.
+
+[lucene-cli Documentation](https://github.com/apache/lucenenet/blob/master/src/dotnet/tools/lucene-cli/docs/index.md)
+-->
+
 ## How to Contribute
 
 Lucene.Net is a very large project (over 400,000 executable lines of code and nearly 1,000,000
lines of text total) and we welcome any and all help to maintain such an effort. Read our
[Contribution Guide](https://github.com/apache/lucenenet/blob/master/CONTRIBUTING.md) or read
on for ways that you can help.
@@ -149,7 +160,7 @@ If you plan to submit multiple pull requests, please submit an [Individual
Contr
 
 ### Command Line
 
-Building on the Command Line is only supported on Windows.
+Building on the Command Line is currently only supported on Windows.
 
 ##### Prerequisites
 
diff --git a/src/dotnet/tools/lucene-cli/docs/index.md b/src/dotnet/tools/lucene-cli/docs/index.md
index 8dc35f6..06f3971 100644
--- a/src/dotnet/tools/lucene-cli/docs/index.md
+++ b/src/dotnet/tools/lucene-cli/docs/index.md
@@ -1,4 +1,4 @@
-# Lucene.Net command line interface (CLI) tools
+# Lucene.Net command line interface (CLI) tools
 
 The Lucene.Net command line interface (CLI) is a new cross-platform toolchain with utilities
for maintaining Lucene.Net and demos for learning basic Lucene.Net functionality.
 
@@ -11,7 +11,7 @@ The Lucene.Net command line interface (CLI) is a new cross-platform toolchain
wi
 Perform a one-time install of the lucene-cli tool using the following dotnet CLI command:
 
 ```
-dotnet tool install -g lucene-cli
+dotnet tool install lucene-cli -g --version 4.8.0-beta00006
 ```
 
 You may then use the lucene-cli tool to analyze and update Lucene.Net indexes and use its
demos.


Mime
View raw message