[SUCS Devel] [Git][sucssite/sucs-site][master] 3 commits: Removed old text readme in favour of markdown one.

[Imran Hussain]

Imran Hussain pushed to branch master at sucssite / sucs-site


Commits:
8f4d62b6 by Peter Jenkins at 2015-09-22T22:13:29Z
Removed old text readme in favour of markdown one.

- - - - -
8027de2c by Peter Jenkins at 2015-09-22T22:14:34Z
Added markdown readme file.

- - - - -
55e0b224 by Imran Hussain at 2015-09-22T22:17:37Z
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

- - - - -


2 changed files:

- − README
- + README.md


Changes:

=====================================
README deleted
=====================================
--- 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


=====================================
README.md
=====================================
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# 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



View it on GitLab: https://projects.sucs.org/sucssite/sucs-site/compare/736a255d04d96a259b057d32fd78d57ae8e586bd...55e0b224cf964ea9f9c6d44f6a8310afbad8ce02
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sucs.org/pipermail/devel/attachments/20150922/88d982cc/attachment.html>