]> source.dussan.org Git - iciql.git/commitdiff
Documentation.
authorJames Moger <james.moger@gmail.com>
Thu, 4 Aug 2011 13:10:30 +0000 (09:10 -0400)
committerJames Moger <james.moger@gmail.com>
Thu, 4 Aug 2011 13:10:30 +0000 (09:10 -0400)
README.markdown

index 08dd864b348c7682f0f70c501e5dc068a2666827..c212bea739ad67fb13d8c144146418e8eda14564 100644 (file)
@@ -7,39 +7,39 @@ iciql **is**...
 - for those who want to write code, instead of SQL, using IDE completion and compile-time type-safety\r
 - small (100KB) with no runtime dependencies\r
 - pronounced *icicle* (although it could be French: *ici ql* - here query language)\r
-- a friendly fork of the H2 [JaQu][jaqu] project\r
+- a friendly fork of the H2 [JaQu](http://h2database.com/html/jaqu.html) project\r
 \r
 iciql **is not**...\r
 \r
 - a complete alternative to JDBC\r
-- designed to compete with more powerful database query tools like [jOOQ][jooq] or [Querydsl][querydsl]\r
-- designed to compete with enterprise [ORM][orm] tools like [Hibernate][hibernate] or [mybatis][mybatis]\r
+- designed to compete with more powerful database query tools like [jOOQ](http://jooq.sourceforge.net) or [Querydsl](http://source.mysema.com/display/querydsl/Querydsl)\r
+- designed to compete with enterprise ORM tools like [Hibernate](http://www.hibernate.org) or [mybatis](http://www.mybatis.org)\r
 \r
 Supported Databases\r
 -------\r
 - [H2](http://h2database.com)\r
 - Support for others is planned and should only require creating a simple "dialect" class.\r
 \r
+License\r
+-------\r
+iciql is distributed under the terms of the [Apache Software Foundation license, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).<br/>\r
+The text of the license is included in the file LICENSE in the root of the project.\r
+\r
 Java Runtime Requirement\r
 -------\r
 iciql requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).\r
  \r
-Current Release\r
+Getting help\r
 -------\r
-documentation @ [iciql.com](http://iciql.com)\r
-issues, binaries, & source @ [Google Code][googlecode]<br/>\r
-sources @ [Github][iciqlsrc]\r
+Read the online documentation available at the [iciql website](http://iciql.com)<br/>\r
+Issues, binaries, & sources @ [Google Code](http://code.google.com/p/iciql)\r
 \r
-License\r
--------\r
-iciql is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense]\r
-\r
-[jaqu]: http://h2database.com/html/jaqu.html "H2 JaQu project"\r
-[orm]: http://en.wikipedia.org/wiki/Object-relational_mapping "Object Relational Mapping"\r
-[jooq]: http://jooq.sourceforge.net "jOOQ"\r
-[querydsl]: http://source.mysema.com/display/querydsl/Querydsl "Querydsl"\r
-[hibernate]: http://www.hibernate.org "Hibernate"\r
-[mybatis]: http://www.mybatis.org "mybatis"\r
-[iciqlsrc]: http://github.com/gitblit/iciql "iciql git repository"\r
-[googlecode]: http://code.google.com/p/iciql "iciql project management"\r
-[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0"
\ No newline at end of file
+Building iciql\r
+----------------\r
+[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.\r
+\r
+1. Import the iciql project into your Eclipse workspace.<br/>\r
+*There will be lots of build errors.*\r
+2. Using Ant, execute the `build.xml` script in the project root.<br/>\r
+*This will download all necessary build dependencies.*\r
+3. Select your iciql project root and **Refresh** the project, this should correct all build problems.
\ No newline at end of file