Permalink
Browse files

Update of README documentation

Replace the HTML version README document with a MarkDown version suitable
for display in GitHub
  • Loading branch information...
1 parent 8f0eebf commit adc21a2d4f3c0dbebb6c04e1154b1acca9e989fe @julian-maughan julian-maughan committed Aug 19, 2011
Showing with 81 additions and 60 deletions.
  1. +81 −0 README.md
  2. +0 −60 readme.html
View
@@ -0,0 +1,81 @@
+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 - <http://www.nhforge.org> - has a range of resources to help you get started,
+including [wikis][A1], [blogs][A2] and [reference documentation][A3].
+
+[A1]: http://nhforge.org/wikis
+[A2]: http://nhforge.org/blogs/nhibernate
+[A3]: http://nhforge.org/doc/nh/en/index.html
+
+Latest Version
+--------------
+
+The quickest way to get the latest release of NHibernate is to add it to your project using
+NuGet (<http://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.
+
+Community Forums
+----------------
+
+There are two official NHibernate community forums:
+
+* [NHibernate Users][B1] - a forum for users to find help using NHibernate
+* [NHibernate Development][B2] - a forum for the developers of NHibernate
+
+[B1]: http://groups.google.com/group/nhusers
+[B2]: http://groups.google.com/group/nhibernate-development
+
+Bug Reports
+-----------
+
+If you find any bugs, please report them using the [JIRA bug tracker][C1]. A
+test-case that demonstrates the issue is usually required. Instructions on providing a test-case
+can be found [here][C2].
+
+[C1]: http://nhibernate.jira.com
+[C2]: http://nhforge.org/blogs/nhibernate/archive/2008/10/04/the-best-way-to-solve-nhibernate-bugs-submit-good-unit-test.aspx
+
+Licenses
+--------
+
+This software is distributed under the terms of the Free Software Foundation [Lesser GNU Public License (LGPL), version 2.1][D1] (see lgpl.txt).
+
+[D1]: http://www.gnu.org/licenses/lgpl-2.1-standalone.html
+
+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][Article] written by Jason Smith
+
+[NUnit]: http://www.nunit.org
+[Nant]: http://nant.sourceforge.net
+[CodeBetter]: http://www.codebetter.com
+[TeamCity]: http://www.jetbrains.com/teamcity
+[GitHub]: http://www.github.com
+[SourceForge]: http://www.sourceforge.net
+[Atlassian]: http://www.atlassian.com
+[Log4net]: http://logging.apache.org/log4net
+[Apache Software Foundation]: http://www.apache.org
+[JetBrains]: http://www.jetbrains.com
+[ReSharper]: http://www.jetbrains.com/resharper
+[LinFu]: http://code.google.com/p/linfu
+[Article]: http://www.codeproject.com/KB/recipes/sets.aspx "Add Support for "Set" Collections to .NET"
View
@@ -1,60 +0,0 @@
-<html>
- <head>
- <title>NHibernate.org - Welcome</title>
- </head>
- <body>
- <h1>Welcome to NHibernate!</h1>
- <hr>
- <p>
- <a href="http://www.nhforge.org/">NHibernate</a> is a .NET based object persistence library for relational databases.
- NHibernate is a port of the excellent Java <a href="http://www.hibernate.org/">Hibernate</a>
- relational persistence tool.
- </p>
- <p>
- You can find tutorials and samples in the <a href="http://www.nhforge.org/">NHibernate community site</a>
- <a href="http://nhforge.org/wikis/">wiki</a> and <a href="http://nhforge.org/blogs/nhibernate/">blog</a>.
- </p>
- <h2>Latest Version</h2>
- <p>
- Details of the latest version of NHibernate can be found on SourceForge at
- <a href="http://sourceforge.net/projects/nhibernate/">http://sourceforge.net/projects/nhibernate/</a>.
- </p>
-
- <h2>Documentation</h2>
- <p>
- All available resources on NHibernate can be found online:
- <a href="http://nhibernate.deepgrok.com/">NHibernate deep grok</a>.
- </p>
- <p>
- The reference documentation for NHibernate is available <a
- href="http://nhforge.org/doc/nh/en/index.html">on-line on the website</a>.
- </p>
-
- <h2>Bug Reports</h2>
- <p>
- If you find any bugs please use the <a href="http://jira.nhforge.org/">JIRA bug tracker</a>.
- </p>
-
- <h2>Licenses</h2>
- <p>
- This software is distributed under the terms of the FSF Lesser GNU Public License (see lgpl.txt).
- </p>
-
- <p>
- This product uses software developed by the Apache Software Foundation (http://www.apache.org/).
- </p>
- <ul>
- <li>log4net</li>
- </ul>
-
- <p>
- This product includes source code from an article written by Jason Smith.
- </p>
- <ul>
- <li>
- Iesi.Collections - original code can be found at <a href="http://www.codeproject.com/csharp/sets.asp">
- Add Support for "Set" Collections to .NET</a>
- </li>
- </ul>
- </body>
-</html>

0 comments on commit adc21a2

Please sign in to comment.