aboutsummaryrefslogtreecommitdiffstats
path: root/src/site/building.mkd
diff options
context:
space:
mode:
Diffstat (limited to 'src/site/building.mkd')
-rw-r--r--src/site/building.mkd35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/site/building.mkd b/src/site/building.mkd
new file mode 100644
index 0000000..b5548bc
--- /dev/null
+++ b/src/site/building.mkd
@@ -0,0 +1,35 @@
+## Building from Source
+
+[Eclipse](http://eclipse.org) is recommended for development as the project settings are preconfigured.
+
+Additionally, [eclipse-cs](http://eclipse-cs.sourceforge.net), [FindBugs](http://findbugs.sourceforge.net), and [EclEmma](http://www.eclemma.org) are recommended development tools.
+
+### Build Dependencies (bundled in repository)
+- [ant-googlecode](http://code.google.com/p/ant-googlecode) (New BSD)
+
+### Build Dependencies (downloaded during build)
+- [Moxie Build Toolkit](http://moxie.gitblit.com) (Apache 2.0)
+- [H2 Database](http://h2database.com) (Eclipse Public License 1.0)
+- [HSQL Database Engine](http://hsqldb.org) (BSD)
+- [Apache Derby Database](http://db.apache.org/derby) (Apache 2.0)
+- [MySQL Connector/J](http://dev.mysql.com/downloads/connector/j) (GPL)
+- [PostgreSQL JDBC Connector](http://jdbc.postgresql.org) (BSD)
+- [JUnit](http://junit.org) (Common Public License)
+- [SLF4J](http://www.slf4j.org) (MIT/X11)
+- [Apache Commons Pool](http://commons.apache.org/pool) (Apache 2.0)
+- [Apache Commons DBCP](http://commons.apache.org/dbcp) (Apache 2.0)
+
+### Instructions
+1. Clone the git repository from [Github](${project.scmUrl}).
+2. Import the iciql project into your Eclipse workspace.<br/>
+*There will be some build errors.*
+3. Using Ant, execute the `build.xml` script in the project root.<br/>
+*This will download all necessary build dependencies.*
+4. Select your iciql project root and **Refresh** the project, this should correct all build problems.
+
+## Contributing
+Patches welcome in any form.
+
+Contributions must be your own original work and must licensed under the [Apache License, Version 2.0][apachelicense], the same license used by iciql.
+
+[apachelicense]: http://www.apache.org/licenses/LICENSE-2.0 "Apache License, Version 2.0" \ No newline at end of file