Permalink
Browse files

Added gradle build documentation

  • Loading branch information...
benfortuna committed Aug 22, 2015
1 parent 4ccbcaf commit c01184fc4ff205fc2ade36883c500a5b47e66e13
Showing with 25 additions and 27 deletions.
  1. +25 −27 README.md
View
@@ -1,8 +1,6 @@
[![Build Status](https://drone.io/github.com/ical4j/ical4j/status.png)](https://drone.io/github.com/ical4j/ical4j/latest) [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/ical4j/ical4j?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-========================
- iCal4j - Release Notes
-========================
+# iCal4j - Release Notes
- For a concise description of the goals and directions of iCal4j please
take a look at docs/index.html.
@@ -18,21 +16,33 @@
be compatible with prior versions of eclipse.
-=====================
- System Requirements
-=====================
+## System Requirements
- Java 5 or later
- commons-codec
- commons-lang3
- slf4j/jcl-over-slf4j
- junit (for unit testing only)
-
-=======================
- How to build - Maven2
-=======================
+## Building with Gradle
+
+iCal4j includes the Gradle wrapper for a simpler and more consistent build.
+
+**Run unit tests**
+
+`./gradlew clean test`
+
+**Build a new release**
+
+`./gradlew clean test release -PreleaseVersion=2.0.0`
+
+**Upload release binaries and packages**
+
+`RELEASE_VERSION=2.0.0 ./gradlew uploadArchives uploadDist`
+
+
+## How to build - Maven2
After installing Maven2 and adding to your path, you need to modify your local
profiles http://wiki.modularity.net.au/ical4j/index.php?title=Maven2. Then
@@ -46,9 +56,7 @@
are generated in the 'target' directory.
-====================
- How to build - Ant
-====================
+## How to build - Ant
If you have downloaded the source distribution, you should be able to package a JAR
file simply by running ant in the root directory. e.g:
@@ -61,11 +69,7 @@
properties (e.g. -Dproject.classpath="..."). You shouldn't need to modify the "build.xml" at all,
so if you do find a need let me know and I'll try to rectify this.
-
-
-=================
- Relaxed Parsing
-=================
+## Relaxed Parsing
iCal4j now has the capability to "relax" its parsing rules to enable parsing of
*.ics files that don't properly conform to the iCalendar specification (RFC2445)
@@ -126,9 +130,7 @@
net.fortuna.ical4j.util.CompatibilityHints.
-======================
- iCal4j and Timezones
-======================
+## iCal4j and Timezones
Supporting timezones in an iCalendar implementation can be a complicated process,
mostly due to the fact that there is not a definitive list of timezone definitions
@@ -159,9 +161,7 @@
on output of the calendar) you will be notified if the changes are invalid.
-============================
- Pre-Java 1.4 Compatibility
-============================
+## Pre-Java 1.4 Compatibility
Choosing Java 1.4 as the minimum required JVM was initially slightly arbitrary, and
probably based on the fact that most people were using 1.4 as a minimum.
@@ -178,9 +178,7 @@
(as these APIs aren't available).
-=================
- Redistribution:
-=================
+## Redistribution:
If you intend to use and distribute iCal4j in your own project please
follow these very simple guidelines:

0 comments on commit c01184f

Please sign in to comment.