Commit 55e0b224 authored by Imran Hussain's avatar Imran Hussain
Browse files

Merge branch 'master' into 'master'

Changed README file to markdown

Changed the README file to use markdown instead of just plain text, as nice documentation is rather useful.

See merge request !7
parents 736a255d 8027de2c
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
# SUCS Site
---
## Project Structure
<br>
| 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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment