X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=52c5e4199b801c4b3ecca76f4d68f04ae906a159;hb=bb51c5812ac2b3f4a3e2d49c0911f149e29c4691;hp=eb38a31b32fa2dbb96b9319a471b693ecf58195e;hpb=3528c308c23c63774cccf92e473abed0d85893e0;p=unfold.git

diff --git a/README b/README
index eb38a31b..52c5e419 100644
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ See the devel/ subdir for more devel-oriented doc.
 
 ==================== 1 minute howto
 
-* requirement is to have python + django installed django
+*  REQUIREMENTS  is to have python + django installed django
 ** should be straightforward
 ** see devel/django-install.txt in case of trouble
 
@@ -22,7 +22,7 @@ $ manage.py syncdb
 [ at this point point it *might* be needed to run
 $ make allst
  but as far as running a local server is concerned you should be good without that 
- feedbakc on this is appreciated]
+ feedback on this is appreciated]
 
 * run a local server:
 $ manage.py runserver 0.0.0.0:8000
@@ -38,6 +38,7 @@ For now there's not much in here;
   this was the simplest possible way to demonstrate deferring authorization elsewhere
 * To logout, click on 'logged as *jean*', this shows a confirmation page..
 
+
 Right now the UI has 4 views: 
 
 * the most useful one being the 'Plugin' view which demonstrates all the available plugins
@@ -46,9 +47,17 @@ Right now the UI has 4 views:
 * slice view : only demonstrates how to use URLs to pass arguments along
 * scroll view : forget about that one, but it does illustrate that some pages can be made public (no need to login)
 * tab view : a hand-made tab widget
-
 (last three from slice/views.py)
 
+
+Third party tools shipped:
+
+* jquery
+* datatables
+* bootstrap
+
+not much effort has been put into coming up with a nice layout and all, feel free to tweak that but it's probably way too early for that
+
 ==================== Contents: 1st level subdirs
 
 ========== code from git
@@ -76,11 +85,13 @@ Right now the UI has 4 views:
   a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
 
 * templates/
+   * some global templates (django templates, i.e. (essentially html) fragments that can be specializied)
+     more on this below
+
 * static/
-  some global stuff:
-   * templates (django templates, i.e. (essentially html) fragments that can be specializied)
-   * static files (css, js, images..)
-  see more about that below
+   * third party stuff (bootstrapfs, jquery, datatables)
+   * + some global static files (css, js, images..)
+     see more about that below too
 
 * devel:
   no code in there, only various notes and other scripts useful for developers
@@ -113,7 +124,38 @@ Right now the UI has 4 views:
       css/
       js/
 
-
 NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another) 
 at any time without any change needed in the code
 
+* filenames / locations
+
+  you can run the following make targets to have a summary of where things are
+
+  $ make list-html list-js list-css list-img
+  -- or --
+  $ make list-all
+
+  as far as possible it's great to have things named the same after e.g. say a plugin name
+    like e.g.
+    plugins/quickfilter.py
+    plugins/templates/quickfilter.html
+    plugins/static/js/quickfilter.js
+    plugins/static/css/quickfilter.css
+
+  it's sometimes not working though, so here are a few additional conventions
+
+    the global layout (for now I needed only one) is named layout-myslice.html
+      it provides the global layout with one menu stuck on top and 2 divs 3/4 1/4
+
+    the views that I currently have are all named in templates/view-<>.html
+      they all extend a layout
+      they should/could admittedly move where they belong (in auth/slice/engine) 
+      so that they would go with their views.py code, but for now it's impler this way
+
+    and there are 3 'widgets' (login, logout, and topmenu) 
+      these could maybe be best implemented as a plugin now that I have the right model for that
+      however esp. for the login/logout I'm not quite sure this will remain over time
+      so for now it's good enough like this
+
+So in summary there's still room for a lot of improvement on this particular topic..
+At the very least topmenu should be made a plugin, and maybe also login/logout