From f9a79c080044d3d729c685e9b09b03530445046c Mon Sep 17 00:00:00 2001 From: jocelyn Date: Tue, 5 Jul 2011 05:31:59 -0700 Subject: [PATCH] Created Source structure (markdown) --- Source-structure.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 Source-structure.md diff --git a/Source-structure.md b/Source-structure.md new file mode 100644 index 00000000..80da56a1 --- /dev/null +++ b/Source-structure.md @@ -0,0 +1,27 @@ +## Currently ## + +- LICENSE : file containing the global license +- README : quick README to point to the github project +- doc/ +- doc/wiki : clone of the associated github wiki repository +- example/ +- test/ +- library/ +- library/ewsgi/ewsgi.ecf +- library/ewsgi/ewsgi.ecf + +Any library/component (in development mode) should follow the following structure (when not needed, there is no need to create the associated folder(s) ): +- **README** +- **COPYRIGHT** +- **LICENSE** +- **.ecf** and **-safe.ecf** +- **library/** : the place to put the source code of the related library/component +- **doc/** : notes, documentations, ... +- **test/** : standard place to put your tests, if you are using Eiffel Software auto-tests, I would suggest to add a new target into the associated .ecf (instead of building a new .ecf under test/ ) +- **example/** : standard place to put the example +- **build/** : a convenient place to compile your project, using this convention, you can setup utilities such as backup to ignore this folder. +- **resource/** : contains pixmap files, .... +- **install/** : contains installation scripts for each platform +- **data/** : contains eventual data for the related tools + +See that we use the singular, since it is an Eiffel convention for naming cluster or folder.