Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 71 lines (40 sloc) 2.125 kb
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
1 # Hibernate OGM
2
6d0066d Sanne Grinovero Update changelog and readme.md in preparation of 4.0.0.Beta1 release
Sanne authored
3 Version: 4.0.0.Beta1 - 3 October 2012
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
4
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
5 ## Description
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
6
f376d6f Sanne Grinovero Small updates in Readme.md
Sanne authored
7 Hibernate OGM is an attempt to store data in a NoSQL data grid using the Hibernate ORM engine rather than rewriting a JPA engine from scratch.
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
8
9 The benefits are fairly obvious:
10 - reimplementing the complex JPA specification is a lot of work
11 - a new implementation would mature at a rather slow rate and risk of bugs would be high
12 - Hibernate is familiar to many people
13
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
14 ## Instructions
15
f376d6f Sanne Grinovero Small updates in Readme.md
Sanne authored
16 Checkout <http://ogm.hibernate.org for more information>
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
17 The code is available on GitHub at <https://github.com/hibernate/hibernate-ogm>
18
19 To build the project, run
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
20
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
21 mvn clean install -s settings-example.xml
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
22
8742e21 Emmanuel Bernard OGM-135 Update readme file on how to build documentation
emmanuelbernard authored
23 ### Documentation
24
25 To build the documentation, set the `buildDocs` property to `true`.
26
27 mvn clean install -DbuildDocs=true -s settings-example.xml
28
29 If you just want to build the documentation, run it from the `hibernate-ogm-documentation/manual` subdirectory.
30
50ea6c1 Emmanuel Bernard Update readme with option to only build html doc
emmanuelbernard authored
31 For rapid documentation testing, you can limit the generated format to html to speed up the process
32
33 mvn clean install -DbuildDocs=true -s settings-example.xml -Djdocbook.format=html_single
34
08ff41f Emmanuel Bernard Add mongodb profile and env variable description
emmanuelbernard authored
35 ### MongoDB
36
37 If you have MongoDB installed on `localhost` and the default port, use the mongodb profile as well
38
39 mvn clean install -s settings-example.xml -Pmongodb
40
41 If you have MongoDB installed in a non default host / port, you can set the environment variables
42 and then run the test suite
43
69288d2 Emmanuel Bernard Fix incorrect MongoDB property in readme file
emmanuelbernard authored
44 export MONGODB_HOSTNAME=mongodb-machine
08ff41f Emmanuel Bernard Add mongodb profile and env variable description
emmanuelbernard authored
45 export MONGODB_PORT=1234
46 mvn clean install -s settings-example.xml -Pmongodb
47
48
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
49 ## Contact
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
50
51 Latest Documentation:
52
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
53 <http://community.jboss.org/en/hibernate/ogm>
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
54
55 Bug Reports:
56
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
57 Hibernate JIRA (preferred): <https://hibernate.onjira.com/browse/OGM>
58 <hibernate-dev@lists.jboss.org>
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
59
60 Free Technical Support:
61
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
62 <https://forum.hibernate.org/viewforum.php?f=31>
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
63
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
64 ## Notes
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
65
c1093c4 Emmanuel Bernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
66 If you want to contribute, come to the <hibernate-dev@lists.jboss.org> mailing list
520ccc2 Emmanuel Bernard Add rudimentary readme file
emmanuelbernard authored
67 or join us on #hibernate-dev on freenode (login required)
68
69 This software and its documentation are distributed under the terms of the
70 FSF Lesser Gnu Public License (see license.txt).
Something went wrong with that request. Please try again.