Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 83 lines (62 sloc) 3.34 kb
adc21a2 @julian-maughan Update of README documentation
julian-maughan authored
1 Welcome to NHibernate
2 =====================
3
4 NHibernate is a mature, open source object-relational mapper for the .NET framework. It is actively developed,
5 fully featured and used in thousands of successful projects.
6
7 The NHibernate community website - <http://www.nhforge.org> - has a range of resources to help you get started,
8 including [wikis][A1], [blogs][A2] and [reference documentation][A3].
9
10 [A1]: http://nhforge.org/wikis
11 [A2]: http://nhforge.org/blogs/nhibernate
12 [A3]: http://nhforge.org/doc/nh/en/index.html
13
14 Latest Version
15 --------------
16
17 The quickest way to get the latest release of NHibernate is to add it to your project using
18 NuGet (<http://nuget.org/List/Packages/NHibernate>).
19
20 Alternatively binaries are available from SourceForge at <http://sourceforge.net/projects/nhibernate>.
21
22 You are encouraged to review the release notes (releasenotes.txt), particularly when upgrading to a
23 later version. The release notes will generally document any breaking changes.
24
25 Community Forums
26 ----------------
27
28 There are two official NHibernate community forums:
29
30 * [NHibernate Users][B1] - a forum for users to find help using NHibernate
31 * [NHibernate Development][B2] - a forum for the developers of NHibernate
32
33 [B1]: http://groups.google.com/group/nhusers
34 [B2]: http://groups.google.com/group/nhibernate-development
35
36 Bug Reports
37 -----------
38
39 If you find any bugs, please report them using the [JIRA bug tracker][C1]. A
40 test-case that demonstrates the issue is usually required. Instructions on providing a test-case
41 can be found [here][C2].
42
43 [C1]: http://nhibernate.jira.com
44 [C2]: http://nhforge.org/blogs/nhibernate/archive/2008/10/04/the-best-way-to-solve-nhibernate-bugs-submit-good-unit-test.aspx
45
46 Licenses
47 --------
48
49 This software is distributed under the terms of the Free Software Foundation [Lesser GNU Public License (LGPL), version 2.1][D1] (see lgpl.txt).
50
51 [D1]: http://www.gnu.org/licenses/lgpl-2.1-standalone.html
52
53 Credits
54 -------
55
56 Many thanks to the following individuals, organisations and projects whose work is so important to the success
57 of NHibernate (in no particular order):
58
59 * [NUnit][] - unit-testing
60 * [Nant][] - build automation
61 * [CodeBetter][] - [TeamCity][] continuous integration and build management server hosting
62 * [GitHub][] and [SourceForge][] - source code hosting
63 * [Atlassian][] - JIRA bug tracker licence and hosting
64 * [Log4net][] - logging, by the [Apache Software Foundation][]
65 * [JetBrains][] - [ReSharper][] licences for NHibernate developers
66 * [LinFu][] - proxy implementation (Philip Laureano)
67 * Iesi.Collections - source code taken from an [article][Article] written by Jason Smith
ccf4f00 @regisbsb Edited README.md via GitHub
regisbsb authored
68 * [Relinq] - Linq provider for NHibernate
adc21a2 @julian-maughan Update of README documentation
julian-maughan authored
69
70 [NUnit]: http://www.nunit.org
71 [Nant]: http://nant.sourceforge.net
72 [CodeBetter]: http://www.codebetter.com
73 [TeamCity]: http://www.jetbrains.com/teamcity
74 [GitHub]: http://www.github.com
75 [SourceForge]: http://www.sourceforge.net
76 [Atlassian]: http://www.atlassian.com
77 [Log4net]: http://logging.apache.org/log4net
78 [Apache Software Foundation]: http://www.apache.org
79 [JetBrains]: http://www.jetbrains.com
80 [ReSharper]: http://www.jetbrains.com/resharper
81 [LinFu]: http://code.google.com/p/linfu
ccf4f00 @regisbsb Edited README.md via GitHub
regisbsb authored
82 [Article]: http://www.codeproject.com/KB/recipes/sets.aspx "Add Support for "Set" Collections to .NET"
83 [Relinq]: http://relinq.codeplex.com/ "re-linq: Generic LINQ provider"
Something went wrong with that request. Please try again.