README.txt

   1
   2 Introduction to Basic
   3
   4 Basic boasts a clean HTML5 structure with extensible CSS classes and ID's for unlimited
   5 theming possibilities as well as a top-down load order for improved SEO. It is fully
   6 responsive out-of-the-box and provides an adaptive, elegant, SASS based grid system (Bourbon Neat).
   7
   8 Basic's goal is to provide themers the building blocks needed to get their designs up and
   9 running quickly and simply.
  10
  11 Basic is perfect if you want a simple, smart, and flexible theme starter.
  12
  13 Less code spam, more ham.
  14
  15 __________________________________________________________________________________________
  16
  17 Installation
  18
  19 - Basic utilizes SASS for adaptive grids and layouts and general structure of the site.
  20   It's recommended to use SASS for building out your theme. You are required to download
  21   the following Ruby Gems and plugins:
  22
  23   - SASS (http://sass-lang.com/)
  24   - Bourbon (http://bourbon.io/)
  25   - Boubon Neat (http://neat.bourbon.io/)
  26
  27 - Basic is meant to be YOUR theme. To change the name of the theme from 'basic' to another name like 'mytheme',
  28 follow these steps (to do BEFORE enabling the theme) :
  29
  30     - rename the theme folder to 'mytheme'
  31     - rename basic.info to mytheme.info
  32     - Edit basic.info and change the name, description, projet (can be deleted)
  33     - In basic.info replace [basic_block_editing] and [basic_rebuild_registry]
  34       by [mytheme_block_editing] and [mytheme_rebuild_registry]
  35     - In template.php change each iteration of 'basic' to 'mytheme'
  36     - In theme-settings.php change each iteration of 'basic' to 'mytheme'
  37
  38 __________________________________________________________________________________________
  39
  40 What are the files for ?
  41 ------------------------
  42
  43 - basic.info                => provide informations about the theme, like regions, css, settings, js ...
  44 - block-system-main.tpl.php => template to edit the content
  45 - block.tpl.php             => template to edit the blocks
  46 - comment.tpl.php           => template to edit the comments
  47 - node.tpl.php              => template to edit the nodes (in content)
  48 - page.tpl.php              => template to edit the page
  49 - template.php              => used to modify drupal's default behavior before outputting HTML through
  50                                the theme
  51 - theme-settings            => used to create additional settings in the theme settings page
  52
  53 In /SASS
  54 -------
  55
  56 - default.sass  => define default classes, browser resets and admin styles (compiles to css/default.css)
  57 - ie8.sass      => used to debug IE8 (compiles to css/ie8.css)
  58 - ie9.sass      => used to debug IE9 (compiles to css/ie9.css)
  59 - layout.sass   => define the layout of the theme (compiles to css/layout.css)
  60 - print.sass    => define the way the theme look like when printed (compiles to css/print.css)
  61 - style.sass    => contains some default font styles. that's where you can add custom css (compiles to css/style.css)
  62 - tabs.sass     => styles for the admin tabs (from ZEN)
  63
  64 __________________________________________________________________________________________
  65
  66 Changing the Layout
  67
  68 The layout used in Basic is fairly similar to the Holy Grail method. It has been tested on
  69 all major browser including IE (5>10), Opera, Firefox, Safari, Chrome ...
  70 The purpose of this method is to have a minimal markup for an ideal display.
  71 For accessibility and search engine optimization, the best order to display a page is ]
  72 the following :
  73
  74     1. header
  75     2. content
  76     3. sidebars
  77     4. footer
  78
  79 This is how the page template is buit in basic, and it works in fluid and fixed layout.
  80 Refers to the notes in layout.css to see how to modify the layout.
  81
  82 __________________________________________________________________________________________
  83
  84 UPDATING BASIC
  85
  86 Once you start using basic, you will massively change it until a point where it has nothing
  87 to do with basic anymore. Unlike ZEN, basic is not intended to be use as a base theme for a
  88 sub-theme (even though it is possible to do so). Because of this, it is not necessary to
  89 update your theme when a new version of BASIC comes out. Always see Basic as a STARTER, and
  90 as soon as you start using it, it is not BASIC anymore, but your own theme.
  91
  92 If you didn't rename your theme, but you don't want to be notified when basic has a new version
  93 by the update module, simply delete "project = "basic" in basic.info
  94
  95 __________________________________________________________________________________________
  96
  97 Thanks for using BASIC, and remember to use the issue queue in drupal.org for any question
  98 or bug report:
  99
 100 http://drupal.org/project/issues/basic
 101
 102 Current maintainers:
 103 * Steve Krueger (SteveK) -http://drupal.org/user/111656 (http://thejibe.com)