nicolabs/ciform
1
0
Fork 0
mirror of https://github.com/nicolabs/ciform.git synced 2026-04-10 16:05:37 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

+ more description on the directory layout

Browse source
This commit is contained in:
cbonar 2012-01-29 20:24:57 +01:00
parent e3001dae6c
commit 63ab9df3b8
1 changed files with 25 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.txt
View file

@ -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
- run ant on each project