Skip to content

Commit 8680e4d

Browse files
Update the README documentation
Replace the HTML version README document with a MarkDown version suitable for display in GitHub
1 parent 150ab24 commit 8680e4d

File tree

2 files changed

+56
-60
lines changed

2 files changed

+56
-60
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Welcome to NHibernate!
2+
======================
3+
4+
[NHibernate](http://www.nhforge.org) is a mature, open source object-relational mapper for the .NET
5+
framework. It is actively developed, 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](http://nhforge.org/wikis), [blogs](http://nhforge.org/blogs/nhibernate) and
9+
[reference documentation](http://nhforge.org/doc/nh/en/index.html).
10+
11+
Latest Version
12+
--------------
13+
14+
The quickest way to get the latest release of NHibernate is to add it to your project using
15+
NuGet (<http://nuget.org/List/Packages/NHibernate>).
16+
17+
Alternatively binaries are available from SourceForge at <http://sourceforge.net/projects/nhibernate>.
18+
19+
You are encouraged to review the release notes (releasenotes.txt), particularly when upgrading to a
20+
later version. The release notes will generally document any breaking changes.
21+
22+
Community Forums
23+
----------------
24+
25+
There are two official NHibernate community forums:
26+
27+
* [NHibernate Users](http://groups.google.com/group/nhusers) - for NHibernate users
28+
* [NHibernate Development](http://groups.google.com/group/nhibernate-development) - for NHibernate developers
29+
30+
Bug Reports
31+
-----------
32+
33+
If you find any bugs, please report them using the [JIRA bug tracker](http://nhibernate.jira.org). A
34+
test-case that demonstrates the issue is usually required. Instructions on providing a test-case
35+
can be found [here](http://nhforge.org/blogs/nhibernate/archive/2008/10/04/the-best-way-to-solve-nhibernate-bugs-submit-good-unit-test.aspx).
36+
37+
Licenses
38+
--------
39+
40+
This software is distributed under the terms of the Free Software
41+
Foundation [Lesser GNU Public License (LGPL), version 2.1](<http://www.gnu.org/licenses/lgpl-2.1-standalone.html>) (see lgpl.txt).
42+
43+
Credits
44+
-------
45+
46+
Thanks go to the following projects, individuals and organisations for being part of the NHibernate story:
47+
48+
* LinFu - thanks to Philip Laureano for donating his LinFu proxy implementation (<http://code.google.com/p/linfu/>).
49+
* Iesi.Collections - includes source code from an article written by Jason Smith, [Add Support for "Set" Collections to .NET](http://www.codeproject.com/KB/recipes/sets.aspx)
50+
* NUnit (<http://www.nunit.org>)
51+
* Nant (<http://nant.sourceforge.net/>)
52+
* TeamCity - hosted by Codebetter for Continuous Integration
53+
* GitHub and SourceForge for source code hosting
54+
* Atlassian for Jira hosting
55+
* log4net - developed by the Apache Software Foundation (<http://www.apache.org>).
56+
* JetBrains - for donating ReSharper licences for NHibernate developers

readme.html

Lines changed: 0 additions & 60 deletions
This file was deleted.

0 commit comments

Comments
 (0)