Mirror of github.com/nicolabs/ciform
Go to file
2012-02-02 17:51:56 +01:00
ant-jsunit-hieatt
ciform # fixes in doc and tests 2012-02-02 17:51:56 +01:00
crypto # fixes in doc and tests 2012-02-02 17:51:56 +01:00
minilib # 'javascript' source directories become 'js' 2012-02-01 13:06:00 +01:00
tools # fixes in doc and tests 2012-02-02 17:51:56 +01:00
.hgignore + starting to add deploy code 2012-02-01 13:30:38 +01:00
README.txt + more description on the directory layout 2012-01-29 20:24:57 +01:00

This folder contains several projects and dependent resources :

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 on each project