Skip to content

Commit

Permalink
Merge pull request #135 from adamretter/improve-build
Browse files Browse the repository at this point in the history
Improve build
  • Loading branch information
joewiz authored Nov 13, 2017
2 parents 044adbf + 92753e2 commit 2a52c75
Show file tree
Hide file tree
Showing 219 changed files with 12,558 additions and 459 deletions.
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
build/
expath-pkg.xml
target/
*.iml
.idea/
*.xpr
local.build.properties
12 changes: 12 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
sudo: false

language: java

jdk:
- oraclejdk8
- oraclejdk9

script: mvn -B test package

notifications:
hipchat: ec8fcfa661addc56a361a8ef536320@integrations
17 changes: 17 additions & 0 deletions GPL2.1-template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
${project.name}
${project.description}
Copyright (C) ${project.inceptionYear} ${organization}

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
504 changes: 504 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
eXist-db Documentation
======================
[![Build Status](https://travis-ci.org/eXist-db/documentation.svg?branch=master)](https://travis-ci.org/eXist-db/documentation)

This repository contains the official documentation for the eXist-db Native XML database and the application for browsing it.

Expand All @@ -11,10 +12,38 @@ This repository contains the official documentation for the eXist-db Native XML

## Building from source

- Dependencies: Apache Ant, eXist 2.2+
- Clone the repository to your system
- From the command line, call `ant`
- An EXPath Application Package (.xar file) is deposited in the `build` directory
- Install this file via the Dashboard > Package Manager.
1. Dependencies: Maven 3.x

2. Clone the repository to your system:

```bash
$ git clone https://github.com/exist-db/documentation.git exist-documentation
```

3. Build the documentation application:
```bash
$ cd exist-documentation
$ mvn clean package
```

4. An EXPath Application Package (.xar file) is deposited in the `target` directory

5. Install this file via the Dashboard > Package Manager.

Find an area of the documentation that needs to be improved? Please raise an issue and submit a pull request!


## Building a Release from source

1. Follow the instructions from [Building from source](#building-from-source)

2. Create a Release:

```bash
$ mvn release:prepare
$ mvn release:perform
```

3. An EXPath Application Package (.xar file) is deposited in the `target` directory

4. If you are a core contributor, you should then commit and push.
7 changes: 0 additions & 7 deletions build.properties

This file was deleted.

44 changes: 0 additions & 44 deletions build.xml

This file was deleted.

5 changes: 0 additions & 5 deletions expath-pkg.xml.tmpl

This file was deleted.

Loading

0 comments on commit 2a52c75

Please sign in to comment.