Permalink
Browse files

Rework README for GitHub

  • Loading branch information...
1 parent 83f2a94 commit 4acbaa4064c5692998a5209313e4bbba4e3d1406 @jodastephen jodastephen committed Jun 24, 2011
Showing with 52 additions and 42 deletions.
  1. +52 −42 README.txt
View
@@ -1,44 +1,18 @@
-/*
- * Copyright (c) 2008, Stephen Colebourne & Michael Nascimento Santos
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- * * Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * * Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * * Neither the name of JSR-310 nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
- * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
- * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
- * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
+ThreeTen
+========
+ThreeTen provides a modern date and time library for Java.
+It is the reference implementation for JSR-310.
-README for ThreeTen, the JSR-310 Reference Implementation
-2010-12-24
+See the home page for more details and downloads:
+Home page and downloads are at Sourceforge.
+http://threeten.sourceforge.net/
+http://sourceforge.net/projects/threeten/
-Welcome to the ThreeTen project, the reference implementation for JSR-310.
-This is a quick guide to help you getting started.
-
-The subversion repository for this codebase is at:
-https://threeten.svn.sourceforge.net/svnroot/threeten/trunk/threeten
+The source code is held primarily at GitHub:
+https://github.com/ThreeTen/threeten
+Geting started
+--------------
The main build process uses Apache Ant - http://ant.apache.org
From the command line the following options will get you started:
ant # downloads libraries and compiles code to a jar file
@@ -49,6 +23,8 @@ From the command line the following options will get you started:
Oracle JDK 1.6 (or OpenJDK) is required to build the codebase.
+Basic user guide
+----------------
ThreeTen divides time into two categories - continuous and human.
Continuous time is based around a single incrementing number from a single epoch.
@@ -78,7 +54,7 @@ Human time is represented via a group of classes:
Support classes include:
- Clock - wraps the current date and time
- ZoneOffset - the offset from UTC, such as -05:00
- - TimeZone - the time zone, such as Europe/London
+ - ZoneId - the time zone, such as Europe/London
- Numerous small interfaces - these link the main classes together
Additional packages provide for:
@@ -87,22 +63,56 @@ Additional packages provide for:
- single field periods
- integration with existing Java classes
+
+Status
+------
The ThreeTen project is used to drive the reference implementation of JSR-310.
The API is currently considered usable and accurate, yet incomplete and subject to change.
If you use this API you must be able to handle incompatible changes in later versions.
Special efforts with the boot classpath are necessary to test and use
the integration with the existing Java classes.
-Test coverage is at about 95% and all current tests pass.
+Test coverage is high and all current tests pass.
Feedback is welcomed!
-Home page: https://threeten.sourceforge.net/
+Home page: http://threeten.sourceforge.net/
Mailing list: http://sourceforge.net/mailarchive/forum.php?forum_name=threeten-develop (develop)
-Wiki: http://wiki.java.net/bin/view/Projects/DateTimeAPI
ThreeTen/JSR-310 team
(See the license files for detail on licensing, warranty and disclaimers)
(All trademarks are hereby granted to their respective owners)
+
+/*
+ * Copyright (c) 2008, Stephen Colebourne & Michael Nascimento Santos
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * * Neither the name of JSR-310 nor the names of its contributors
+ * may be used to endorse or promote products derived from this software
+ * without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */

0 comments on commit 4acbaa4

Please sign in to comment.