From 63ab9df3b8bce60939fa456cfdc016703f7215c2 Mon Sep 17 00:00:00 2001 From: cbonar Date: Sun, 29 Jan 2012 20:24:57 +0100 Subject: [PATCH] + more description on the directory layout --- README.txt | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.txt b/README.txt index bfb643c..5c34ea5 100644 --- a/README.txt +++ b/README.txt @@ -1,12 +1,31 @@ This folder contains several projects and dependent resources : -ciform -> Ciform project directory tree -codecs -> Dependent Javascript libraries for Ciform - Each subdirectory is a Maven-style project with a build script that generates Ivy artifacts for use with Ciform. - Run "ant install" to generate and import artifacts into the local Ivy repository. -tools -> Tools required to build the projects : extract required binaries before building the projects +ciform/ -> Ciform project root +codecs/ -> Dependent Javascript libraries for Ciform + Each subdirectory is a Maven-style project with a build script that generates Ivy artifacts for use with Ciform. + Run "ant install" to generate and import artifacts into the local Ivy repository. +minilib/ -> minilib project root +tools/ -> Tools required to build the projects : extract required binaries before building the projects +tools/build/ Custom scripts and configuration files for this project + +Each project may contain the following directories/files : + - build.properties Default properties for the build script + - build.xml Ant build script + - build/ Temporary build files + - ivy.xml Ivy descriptor for the project (includes version and dependencies) + - src/main/js Main source files (Javascript) + - src/main/php Main source files (PHP) + - src/pix Pictures sources (logos, icons) + - target/ Generated files for distribution + - target/doc Documents related to the project + - target/doc/api Developer docs for the project + - target/doc/ivy Dependency report for the project + - target/doc/lib Library artifacts of this project + - target/doc/lib/*-min.js Minified libraries + - target/doc/lib/lib*.js Standalone libraries (contains the project and all its dependencies) + - test/resources Different kind of resources for the tests To build the projects, you should only need to : - extract the required binaries into the 'tools' directory - rename 'common-sample.properties' in 'tools/build' to 'common.properties' and edit it to reflect your local configuration - - run ant in each project \ No newline at end of file + - run ant on each project \ No newline at end of file