documented the new layout (single templates/ and static/)
[myslice.git] / README
1 The contents of this module:
2
3 ==================== 1st level subdirs
4 * myslice: 
5   this is the sjango project', where to look for
6   . settings
7   . urls
8   . common static files 
9
10 * insert_above: 
11   a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
12   much like our past drupal_set_html_head() 
13
14 * auth: 
15   a django 'app' that deals with authentication
16
17 * slice:
18   a django app for dealing with slice views
19
20 * templates/
21 * static/
22   initially I had started to keep:
23    * templates (html templates with embedded python-like django chunks) 
24    * static files (css, js, images..)
25   locally in the app were they belong
26   but I ended up with having the need to move up and down the tree endlessly
27   so for the beginning at least, I have moved everything in a unique place
28   this convention is subject to change
29
30 ---
31 * devel:
32   no code in there, only various notes and other scripts useful for developers
33
34 * all-static: (generated, no need to source-control)
35   this is where 'manage.py collectstatic' will gather all your static contents if you run a local server
36   make has convenience targets to refresh this area
37   $ make clean-static 
38   $ make static 
39
40 ==================== initial conventions for templates and static
41
42 * templates:
43   we store this under templates/ within the corresponding app, e.g.
44   auth/templates/login.html
45   for now this is only about html, but the engine can be used for rendering anything including json or whatever..
46
47 * static files:
48   we chose to have all static files (images, but also javascript and stylesheets) in the various
49   proj or app where they belong, under a static/ subdir that has this structure:
50   where-it-belongs/
51     static/
52       img/
53       css/
54       js/
55   the stuff I have so far is in myslice/ because it looks common to all apps..
56
57
58