Skip to content

Commit

Permalink
Merge pull request #114 from ical4j/feature/restructure-project
Browse files Browse the repository at this point in the history
Feature/restructure project
  • Loading branch information
benfortuna committed Nov 10, 2016
2 parents 2a4378c + 0c6a787 commit 15eb9b4
Show file tree
Hide file tree
Showing 151 changed files with 102 additions and 25,497 deletions.
8 changes: 0 additions & 8 deletions .cvsignore

This file was deleted.

11 changes: 0 additions & 11 deletions .hgignore

This file was deleted.

2 changes: 1 addition & 1 deletion CHANGELOG
Expand Up @@ -4,7 +4,7 @@

See the changelog report for further details:

http://m2.modularity.net.au/projects/ical4j/changelog.html
http://ical4j.github.io/docs/ical4j/release-notes

==

Expand Down
48 changes: 24 additions & 24 deletions README.md
Expand Up @@ -3,62 +3,62 @@
# iCal4j - Release Notes

- For a concise description of the goals and directions of iCal4j please
take a look at docs/index.html.
take a look at the [open issues](https://github.com/ical4j/ical4j/issues).

- You will find examples of how to use iCal4j at docs/introduction.html
and throughout the API documentation.
- You will find examples of how to use iCal4j in [the wiki](https://github.com/ical4j/ical4j/wiki)
and throughout the [API documentation](https://ical4j.github.io/docs/ical4j/api).

- Detailed descriptions of changes included in each release may be found
in the CHANGELOG.
in the [CHANGELOG](https://ical4j.github.io/docs/ical4j/release-notes).

- iCal4j was created with the help of eclipse version 3.2 [http://eclipse.org].
Note that the project metadata included in the source version of iCal4j may not
be compatible with prior versions of eclipse.
- iCal4j was created with the help of [Open Source](http://opensource.org) software.


## System Requirements

- Java 6 or later

See [here](docs/Dependencies.md) for further details.
See [here](https://github.com/ical4j/ical4j/docs/Dependencies.md) for further details.

## Building with Gradle

iCal4j includes the Gradle wrapper for a simpler and more consistent build.

**Run unit tests**

`./gradlew clean test`
./gradlew clean test

**Build a new release**

`./gradlew clean test release -Prelease.forceVersion=2.0.0`
./gradlew clean test release -Prelease.forceVersion=2.0.0

**Upload release binaries and packages**

`RELEASE_VERSION=2.0.0 ./gradlew uploadArchives uploadDist`
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
open a command prompt to the location of the iCal4j source and execute the following:
After installing Maven2 and adding to your path, you need to [modify your local
profiles](https://github.com/ical4j/ical4j/wiki/Maven2). Then
open a command prompt to the location of the iCal4j source and execute the following:

[iCal4j-2.0-beta1-src] >mvn clean install
or
[iCal4j-2.0-beta1-src] >mvn clean install -P modularity-snapshots
$ mvn clean install

or

$ mvn clean install -P modularity-snapshots

This will build and install iCal4j in your local repository. Build artifacts
are generated in the 'target' directory.


## 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:
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:

C:\Libs\iCal4j-2.0-beta1-src\>ant
C:\Libs\iCal4j-2.0-beta1-src\>ant

If for some reason you would like to override the default build classpath, I would
suggest creating a "build.properties" file (see the provided sample) in the root directory
Expand All @@ -73,7 +73,7 @@ iCal4j includes the Gradle wrapper for a simpler and more consistent build.

- You can relax iCal4j's unfolding rules by specifying the following system property:

ical4j.unfolding.relaxed=true
ical4j.unfolding.relaxed=true

Note that I believe this problem is not restricted to Mozilla calendaring
products, but rather may be caused by UNIX/Linux-based applications relying on the
Expand Down Expand Up @@ -105,7 +105,7 @@ iCal4j includes the Gradle wrapper for a simpler and more consistent build.

- You may also relax the parsing rules of iCal4j by setting the following system property:

ical4j.parsing.relaxed=true
ical4j.parsing.relaxed=true

This property is intended as a general relaxation of parsing rules to allow for parsing
otherwise invalid calendar files. Initially enabling this property will allow for the
Expand All @@ -116,12 +116,12 @@ iCal4j includes the Gradle wrapper for a simpler and more consistent build.

- Microsoft Outlook also appears to provide quoted TZID parameter values, as follows:

DTSTART;TZID="Pacific Time (US & Canada),Tijuana":20041011T223000
DTSTART;TZID="Pacific Time (US & Canada),Tijuana":20041011T223000

To allow for compatibility with such iCalendar files you should specify the
following system property:

ical4j.compatibility.outlook=true
ical4j.compatibility.outlook=true

The full set of system properties may be found in
net.fortuna.ical4j.util.CompatibilityHints.
Expand Down
9 changes: 0 additions & 9 deletions build.properties.sample

This file was deleted.

0 comments on commit 15eb9b4

Please sign in to comment.