|
1 | 1 | # eXist-db Function Documentation Browser App |
| 2 | + |
2 | 3 | [](https://travis-ci.com/eXist-db/function-documentation) |
3 | 4 | [](http://www.exist-db.org/exist/apps/homepage/index.html) |
4 | 5 |
|
5 | 6 | <img src="src/main/xar-resources/icon.png" align="left" width="15%"/> |
6 | 7 |
|
7 | | -This repository contains the function documentation borwser app for the [eXist-db native XML database](http://www.exist-db.org). |
| 8 | +This repository contains the function documentation browser app for the [eXist-db native XML database](http://www.exist-db.org). |
8 | 9 |
|
9 | 10 | ## Dependencies |
10 | | -- [Maven](https://maven.apache.org): 3.5.2 |
11 | | -- [eXist-db](http://exist-db.org): 4.0.0 |
| 11 | + |
| 12 | +- [Maven](https://maven.apache.org): `3.5.2` |
| 13 | +- [eXist-db](http://exist-db.org): `4.0.0` |
12 | 14 |
|
13 | 15 | ## Installation |
14 | | -- Just go to your eXist server's Dashboard and select Function Documentation. |
15 | | -- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/). |
| 16 | + |
| 17 | +- Just go to your eXist server's Dashboard and select Function Documentation. |
| 18 | +- Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at [http://exist-db.org/exist/apps/public-repo/](http://exist-db.org/exist/apps/public-repo/). |
16 | 19 |
|
17 | 20 | ## Building from source |
18 | | -1. Clone the repository to your system: |
19 | | - ```bash |
20 | | - $ git clone https://github.com/exist-db/function-documentation.git |
21 | | - ``` |
22 | 21 |
|
23 | | -2. Build the function documentation application: |
24 | | - ```bash |
25 | | - $ cd function-documentation |
26 | | - $ mvn clean package |
27 | | - ``` |
28 | | - The compiled `.xar` file is located in the `/target` directory |
| 22 | +1. Clone the repository to your system: |
| 23 | + |
| 24 | + ```bash |
| 25 | + git clone https://github.com/exist-db/function-documentation.git |
| 26 | + ``` |
29 | 27 |
|
30 | | -3. Install this file via the Dashboard > Package Manager. |
| 28 | +2. Build the function documentation application: |
| 29 | + |
| 30 | + ```bash |
| 31 | + cd function-documentation |
| 32 | + mvn clean package |
| 33 | + ``` |
| 34 | + |
| 35 | + The compiled `.xar` file is located in the `/target` directory |
| 36 | + |
| 37 | +3. Install this file via the Dashboard > Package Manager. |
31 | 38 |
|
32 | 39 | ## License |
| 40 | + |
33 | 41 | LGPLv2.1 [eXist-db.org](http://exist-db.org/exist/apps/homepage/index.html) |
0 commit comments