| Timothy Bennett | ff51f4f | 2005-08-23 04:50:13 +0000 | [diff] [blame] | 1 | *********************** |
| 2 | * Apache Felix README * |
| 3 | *********************** |
| 4 | |
| 5 | This document is basically a catch-all for general information about the Apache |
| 6 | Felix project. It is anticipated that this document will be updated from time |
| 7 | to time with new information. |
| 8 | |
| 9 | SVN PROJECT STRUCTURE |
| 10 | |
| 11 | The Apache Felix project has the following directory structure in order to organize |
| 12 | the project's varied product artifacts. |
| 13 | |
| 14 | + framework |
| 15 | + sandbox |
| 16 | + tools |
| 17 | |
| 18 | The *framework* directory contains the source and build tree for the OSGi-compliant |
| 19 | framework implementation. It is, of course, the primary product of this project. |
| 20 | |
| 21 | The *sandbox* directory contains a directory tree whereby project committers can |
| 22 | store various experimental and working versions of code. Each committer that wishes |
| 23 | to utilize the sandbox should create a subdirectory named after his/her apache username. |
| 24 | |
| 25 | e.g. |
| 26 | |
| 27 | - sandbox |
| 28 | + erodriguez |
| 29 | + rickhall |
| 30 | + tbennett |
| 31 | |
| 32 | The *tools* directory contains a directory tree for various tools that may be developed |
| 33 | in association with this project. One such tool is the maven-osgi-plugin currently under |
| 34 | development for the MAVEN2 build system. A tools directory may itself have multiple |
| 35 | products each requiring their own directory. |
| 36 | |
| 37 | e.g. |
| 38 | |
| 39 | - tools |
| 40 | - maven2 |
| 41 | + maven-osgi-plugin |
| 42 | |
| 43 | As the project matures, we certainly may see other directories created to organize other |
| 44 | types of products. |