You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,17 +83,21 @@ Also include any error stacktraces and a code snippet to reproduce the error if
83
83
84
84
## For Driver Developers
85
85
86
-
This section targets at people who would like to compile the source code on their own machine for the purpose of, for example, contributing a PR to this repository.
87
-
Before contributing to this project, please take a few minutes and read our [Contributing Criteria](https://github.com/neo4j/neo4j-java-driver/blob/1.6/CONTRIBUTING.md#want-to-contribute).
86
+
This section targets users who would like to compile the driver source code on their own machine for the purpose of, for example, contributing a PR.
87
+
Before contributing to this project, please take a few minutes to read our [Contribution Guide](https://github.com/neo4j/neo4j-java-driver/blob/1.6/CONTRIBUTING.md#want-to-contribute).
88
+
88
89
89
90
### Java Version
90
91
91
-
Starting from 1.5 series the driver is compiled on Java 8. For previous series, the code compilation requires Java 7.
92
+
For the 1.5 series driver and above, source code _must_ compile on Java 8.
93
+
For previous versions, the compilation requires Java 7.
94
+
92
95
93
96
### Building
94
97
95
98
The source code here reflects the current development status of a new driver version.
96
-
If you want to use the driver in your project, please use the released driver via Maven Central or check out the code with git tags of corresponding versions instead.
99
+
To use the driver in a project, please use the released driver via Maven Central or check out the code with git tags of corresponding versions instead.
100
+
97
101
98
102
#### Running Tests and Creating a Package
99
103
@@ -106,15 +110,17 @@ mvn clean install
106
110
```
107
111
When running integration tests, the driver would start a Neo4j instance and a Neo4j cluster on your local machine.
108
112
Your tests might fail due to
109
-
* a Neo4j server instance is already running on your machine and occupied default server ports,
110
-
*missing the right to download neo4j enterprise artifacts.
113
+
* a Neo4j server instance is already running on your machine and occupying the default server ports,
114
+
*a lack of persmission to download Neo4j Enterprise artifacts.
111
115
112
-
If you do not wish to run integration tests, then use the following command to run without integration tests:
116
+
To skip the integration tests, use:
113
117
```
114
118
mvn clean install -DskipITs
115
119
```
116
120
121
+
117
122
#### Windows
118
123
119
-
If you are building on windows, you need to run install with admin right, as Neo4j installation requires admin right to install as a service and
120
-
start for integration tests.
124
+
If you are building on windows, you will need to run the install with admin rights.
125
+
This is because integration tests require admin privileges to install and start a service.
0 commit comments