diff --git a/README b/README deleted file mode 100644 index b0a72648fde3c2d1bb10614526dc4e8edaaf358a..0000000000000000000000000000000000000000 --- a/README +++ /dev/null @@ -1,34 +0,0 @@ -What's in these 'ere folders: - -components/ - PHP components of the site, each drives a separate element - e.g. - static content, the library, the help system, etc. -htdocs/ - Where all served content is to be found: - css/ - Cascading StyleSheets - files/ - Files for download (e.g. Help examples) - images/ - Images used by the site skin - js/ - JavaScript - tinymce/ - Placeholder dir for TinyMCE, which should not itself - be stored in SVN - pictures/ - Images used in the content (e.g. /Help) -lib/ - Custom libraries used by the site - e.g. session library -plugins/ - Custom Smarty plugins used by the site - e.g. banana drawing - function -static/ - Static content for the static content components (includes help) - fragments/ - Any HTML fragments used to make up parts of pages (e.g. - secondary bars) -templates/ - Smarty templates -templates_c/ - Compiled Smarty templates - do not use this dir diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..b0524b90341d2de8e8715dc7ff6cba941d4f4267 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# SUCS Site +--- +## Project Structure +
+ +| Directory | Description | +| --------- | ----------- | +| components | PHP components of the site, each drives a separate element - e.g. static content, the library, the help system, etc. | +| htdocs/css | Cascading StyleSheets | +| htdocs/files | Files for download (e.g. Help examples) | +| htdocs/images | Images used by the site skin | +| htdocs/js | JavaScript | +| htdocs/js/tinymce | Placeholder dir for TinyMCE, which should not itself be stored in SVN | +| htdocs/pictures | Images used in the content (e.g. /Help) | +| lib | Custom libraries used by the site - e.g. session library | +| plugins | Custom Smarty plugins used by the site - e.g. banana drawing function | +| static | Static content for the static content components (includes help) | +| static/fragments | Any HTML fragments used to make up parts of pages (e.g. secondary bars) | +| templates | Smarty templates | +| templates_c | Compiled Smarty templates - do not use this dir | \ No newline at end of file