Welcome to NHibernate

NHibernate is a mature, open source object-relational mapper for the .NET framework. It is actively developed, fully featured and used in thousands of successful projects.

The NHibernate community website - https://nhibernate.info - has a range of resources to help you get started, including howtos, blogs and reference documentation.

Latest Release Version

The quickest way to get the latest release of NHibernate is to add it to your project using NuGet (https://nuget.org/List/Packages/NHibernate).

Alternatively binaries are available from SourceForge at http://sourceforge.net/projects/nhibernate.

You are encouraged to review the release notes (releasenotes.txt), particularly when upgrading to a later version. The release notes will generally document any breaking changes.

Nightly Development Builds

The quickest way to get the latest development build of NHibernate is to add it to your project using NuGet from Cloudsmith feed (https://cloudsmith.io/~nhibernate/repos/nhibernate-core/packages/).

In order to make life a little bit easier you can register the package source in the NuGet.Config file in the top folder of your project, similar to the following.

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="NHibernateDevBuilds" value="https://nuget.cloudsmith.io/nhibernate/nhibernate-core/v3/index.json" />
  </packageSources>
</configuration>

Package repository hosting is graciously provided by Cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence.

Community Forums

There are two official NHibernate community forums:

• NHibernate Users - a forum for users to find help using NHibernate
• NHibernate Development - a forum for the developers of NHibernate

Bug Reports

If you find any bugs, please report them using the GitHub issue tracker. A test-case that demonstrates the issue is usually required. Instructions on providing a test-case can be found in contributing guidelines or here.

Licenses

• This software is distributed under the terms of the Free Software Foundation Lesser GNU Public License (LGPL), version 2.1 (see LICENSE.txt).
• The documentation for this software is distributed under the terms of the Free Software Foundation GNU Free Documentation License (GNU FDL), version 1.1 (see doc/LICENSE.txt).

Credits

Many thanks to the following individuals, organisations and projects whose work is so important to the success of NHibernate (in no particular order):

• NUnit - unit-testing
• Nant - build automation
• CodeBetter - TeamCity continuous integration and build management server hosting
• GitHub and SourceForge - source code hosting
• Atlassian - JIRA bug tracker licence and hosting
• Log4net - logging, by the Apache Software Foundation
• JetBrains - ReSharper licences for NHibernate developers
• LinFu - proxy implementation (Philip Laureano)
• Iesi.Collections - source code taken from an article written by Jason Smith
• Relinq - Linq provider for NHibernate
• AsyncGenerator - Roslyn based async C# code generator by @maca88