Skip to content

Commit aa609e3

Browse files
NightOwl888NightOwl888
committed
Updated README.md
1 parent fbd4ad5 commit aa609e3

File tree

1 file changed

+84
-7
lines changed

1 file changed

+84
-7
lines changed

‎README.md

Lines changed: 84 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Apache Lucene.Net
22

3-
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.
3+
Apache Lucene.Net is a .NET 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.
44

55
The Apache Lucene.Net web site is at:
66
http://lucenenet.apache.org
@@ -31,13 +31,13 @@ Working toward Lucene.Net 4.8.0 (currently in BETA)
3131
PM> Install-Package Lucene.Net
3232
```
3333

34-
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)
34+
As of 4.8.0, Lucene.Net is now divided into several NuGet sub-packages. See the [complete list of Lucene.Net sub-packages on NuGet.org](https://www.nuget.org/packages?q=lucene.net)
3535

3636
## Documentation
3737

3838
[Lucene.Net WIKI](https://cwiki.apache.org/confluence/display/LUCENENET/Lucene.Net)
3939

40-
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/).
40+
We don't yet have API documentation for Lucene.Net 4.8.0, but the API is similar to [Lucene 4.8.0](https://lucene.apache.org/core/4_8_0/).
4141

4242
### Legacy Versions
4343

@@ -78,15 +78,63 @@ Before you start working on a pull request, please read our [Contributing](https
7878

7979
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).
8080

81-
## Build
81+
## Building and Testing
8282

83-
To build the source, clone or download the repository. From the repository root, execute:
83+
### Command Line
84+
85+
Building on the Command Line is only supported on Windows.
86+
87+
##### Prerequisites
88+
89+
1. [Powershell](https://msdn.microsoft.com/en-us/powershell/scripting/setup/installing-windows-powershell) 3.0 or higher (see [this question](http://stackoverflow.com/questions/1825585/determine-installed-powershell-version) to check your Powershell version)
90+
2. [.NET Framework 4.5.1 Developer Pack](https://www.microsoft.com/en-us/download/details.aspx?id=40772) (Under Programs & Features, check whether you have the .NET Framework 4.5.1 SDK)
91+
92+
##### Execution
93+
94+
To build the source, clone or download and unzip the repository. From the repository root, execute:
8495

8596
```
86-
> build -pv:4.8.0.1000
97+
> build [options]
8798
```
8899

89-
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:
100+
##### Build Options
101+
102+
<table>
103+
<tr>
104+
<th>Short</th>
105+
<th>Long</th>
106+
<th>Description</th>
107+
<th>Example</th>
108+
</tr>
109+
<tr>
110+
<td>&#8209;config</td>
111+
<td>&#8209;&#8209;Configuration</td>
112+
<td>The build configuration ("Release" or "Debug").</td>
113+
<td>build&nbsp;&#8209;&#8209;Configuration:Debug</td>
114+
</tr>
115+
<tr>
116+
<td>&#8209;pv</td>
117+
<td>&#8209;&#8209;PackageVersion</td>
118+
<td>The NuGet package version. If not supplied, will use the version from the Version.proj file.</td>
119+
<td>build&nbsp;&#8209;pv:4.8.0&#8209;beta00001</td>
120+
</tr>
121+
<tr>
122+
<td>&#8209;t</td>
123+
<td>&#8209;&#8209;Test</td>
124+
<td>Runs the tests after building. Note that testing typically takes upwards of 2 hours.</td>
125+
<td>build&nbsp;&#8209;t</td>
126+
</tr>
127+
<tr>
128+
<td>&#8209;v</td>
129+
<td>&#8209;&#8209;Version</td>
130+
<td>The assembly file version. If not supplied, will use the PackageVersion (excluding any pre-release tag).</td>
131+
<td>build&nbsp;&#8209;pv:4.8.0&#8209;beta00001&nbsp;&#8209;v:4.8.0</td>
132+
</tr>
133+
</table>
134+
135+
NuGet packages are output by the build to the `/release/NuGetPackages/` directory. Test results (if applicable) are output to the `/release/TestResults/` directory.
136+
137+
You can setup Visual Studio to read the NuGet packages like any NuGet feed by following these steps:
90138

91139
1. In Visual Studio, right-click the solution in Solution Explorer, and choose "Manage NuGet Packages for Solution"
92140
2. Click the gear icon next to the Package sources dropdown.
@@ -96,3 +144,32 @@ This will build, version, and create NuGet `.nupkg` packages in the directory `/
96144
6. Click Ok
97145

98146
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.
147+
148+
### Visual Studio
149+
150+
#### .NET Framework
151+
152+
##### Prerequisites
153+
154+
1. Visual Studio 2012+
155+
2. [.NET Framework 4.5.1 Developer Pack](https://www.microsoft.com/en-us/download/details.aspx?id=40772) (Under Programs & Features, check whether you have the .NET Framework 4.5.1 SDK)
156+
3. [NUnit3 Test Adapter](https://marketplace.visualstudio.com/items?itemName=NUnitDevelopers.NUnit3TestAdapter)
157+
158+
##### Execution
159+
160+
Open `Lucene.Net.sln` to compile/test in .NET Framework 4.5.1
161+
162+
163+
#### .NET Core
164+
165+
##### Prerequisites
166+
167+
1. [Visual Studio 2015 Update 3](http://stackoverflow.com/a/40068343) (NOTE: Other Visual Studio versions, including 2017 are not supported)
168+
2. [1.1 with SDK Preview 2.1 build 3177](https://github.com/dotnet/core/blob/master/release-notes/download-archive.md)
169+
3. [NUnit3 Test Adapter](https://marketplace.visualstudio.com/items?itemName=NUnitDevelopers.NUnit3TestAdapter)
170+
171+
##### Execution
172+
173+
Open `Lucene.Net.Portable.sln` to compile under .NET Standard and test under .NET Core
174+
175+
> NOTE: You may need to run `dotnet restore` from the command line prior to opening the solution in order to successfully compile.

0 commit comments

Comments
 (0)