Skip to content
Newer
Older
100644 67 lines (38 sloc) 1.87 KB
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
1 # Hibernate OGM
2
a3bf422 @Sanne update version in readme.md to not confuse github users
Sanne authored
3 Version: 4.0.0-SNAPSHOT
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
4
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
5 ## Description
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
6
f376d6f @Sanne 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 @emmanuelbernard 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 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
14 ## Instructions
15
f376d6f @Sanne Small updates in Readme.md
Sanne authored
16 Checkout <http://ogm.hibernate.org for more information>
c1093c4 @emmanuelbernard 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 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
20
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
21 mvn clean install -s settings-example.xml
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
22
8742e21 @emmanuelbernard 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
08ff41f @emmanuelbernard Add mongodb profile and env variable description
emmanuelbernard authored
31 ### MongoDB
32
33 If you have MongoDB installed on `localhost` and the default port, use the mongodb profile as well
34
35 mvn clean install -s settings-example.xml -Pmongodb
36
37 If you have MongoDB installed in a non default host / port, you can set the environment variables
38 and then run the test suite
39
69288d2 @emmanuelbernard Fix incorrect MongoDB property in readme file
emmanuelbernard authored
40 export MONGODB_HOSTNAME=mongodb-machine
08ff41f @emmanuelbernard Add mongodb profile and env variable description
emmanuelbernard authored
41 export MONGODB_PORT=1234
42 mvn clean install -s settings-example.xml -Pmongodb
43
44
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
45 ## Contact
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
46
47 Latest Documentation:
48
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
49 <http://community.jboss.org/en/hibernate/ogm>
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
50
51 Bug Reports:
52
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
53 Hibernate JIRA (preferred): <https://hibernate.onjira.com/browse/OGM>
54 <hibernate-dev@lists.jboss.org>
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
55
56 Free Technical Support:
57
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
58 <https://forum.hibernate.org/viewforum.php?f=31>
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
59
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
60 ## Notes
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
61
c1093c4 @emmanuelbernard OGM-135 Add sample settings.xml fiel and migrate readme to Markdown
emmanuelbernard authored
62 If you want to contribute, come to the <hibernate-dev@lists.jboss.org> mailing list
520ccc2 @emmanuelbernard Add rudimentary readme file
emmanuelbernard authored
63 or join us on #hibernate-dev on freenode (login required)
64
65 This software and its documentation are distributed under the terms of the
66 FSF Lesser Gnu Public License (see license.txt).
Something went wrong with that request. Please try again.