Skip to content

Commit 5506f19

Browse files
committed
[doc] Update the build instructions to make things easier for users
1 parent ad7660d commit 5506f19

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

BUILD.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,33 @@ Elemental itself is written in Java 8. The build system is [Apache Maven](http:/
44

55
To build Elemental:
66

7-
- Checkout the Git Repository
8-
- Execute a Maven to compile Elemental
7+
1. Checkout the Git Repository
98

10-
```bash
11-
$ git clone https://github.com/evolvedbinary/elemental.git
12-
$ cd elemental
13-
$ git checkout gold
14-
$ mvn -DskipTests package
15-
```
9+
```bash
10+
$ git clone https://github.com/evolvedbinary/elemental.git
11+
$ git checkout gold
12+
$ cd elemental
13+
```
14+
15+
2. Execute Maven to compile Elemental
16+
17+
We provide a build script to try and make common build tasks easier for users.
18+
19+
For macOS/Linux/Unix platforms:
20+
```bash
21+
$ ./build.sh quick
22+
```
23+
24+
or, for Windows platforms:
25+
```cmd
26+
> build.bat quick
27+
```
1628

1729
From here, you now have a compiled version of Elemental in the `exist-distribution/target` folder that you may use just as you would an installed version of Elemental. An installer is also build and present in `exist-installer/target` for easy installation elsewhere.
1830

19-
Useful build switches:
20-
- `-Ddocker=true` : builds the docker image
21-
- `-DskipTests` : skips running tests
22-
- `-Ddependency-check.skip=true` : skips validating dependencies
31+
The `quick` build target will build distribution directory that can be found at: `exist-distribution/target/elemental-x.y.x-dir`.
32+
If you wish to see what other build targets are available, you can run `./build.sh --help` (or `build.bat --help` on Windows platforms).
33+
2334

2435
Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml "How to build eXist-db").
2536

0 commit comments

Comments
 (0)