Updated neat and bourbon for D7 as per issue #2185821
[project/basic.git] / 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, project (can be deleted), replace all other instances of "basic" ie. [basic_tabs] would become [mytheme_tabs]
33     - In template.php change each iteration of 'basic' to 'mytheme'
34     - In theme-settings.php change each iteration of 'basic' to 'mytheme'
35
36 __________________________________________________________________________________________
37
38 What are the files for ?
39 ------------------------
40
41 - basic.info                => provide informations about the theme, like regions, css, settings, js ...
42 - block-system-main.tpl.php => template to edit the content
43 - block.tpl.php             => template to edit the blocks
44 - comment.tpl.php           => template to edit the comments
45 - node.tpl.php              => template to edit the nodes (in content)
46 - page.tpl.php              => template to edit the page
47 - template.php              => used to modify drupal's default behavior before outputting HTML through
48                                the theme
49 - theme-settings            => used to create additional settings in the theme settings page
50
51 In /SASS
52 -------
53
54 - default.sass  => define default classes, browser resets and admin styles (compiles to css/default.css)
55 - ie8.sass      => used to debug IE8 (compiles to css/ie8.css)
56 - ie9.sass      => used to debug IE9 (compiles to css/ie9.css)
57 - layout.sass   => define the layout of the theme (compiles to css/layout.css)
58 - print.sass    => define the way the theme look like when printed (compiles to css/print.css)
59 - style.sass    => contains some default font styles. that's where you can add custom css (compiles to css/style.css)
60 - tabs.sass     => styles for the admin tabs (from ZEN)
61
62 __________________________________________________________________________________________
63
64 Changing the Layout
65
66 The layout used in Basic is fairly similar to the Holy Grail method. It has been tested on
67 all major browser including IE (5>10), Opera, Firefox, Safari, Chrome ...
68 The purpose of this method is to have a minimal markup for an ideal display.
69 For accessibility and search engine optimization, the best order to display a page is ]
70 the following :
71
72     1. header
73     2. content
74     3. sidebars
75     4. footer
76
77 This is how the page template is buit in basic, and it works in fluid and fixed layout.
78 Refers to the notes in layout.css to see how to modify the layout.
79
80 __________________________________________________________________________________________
81
82 UPDATING BASIC
83
84 Once you start using basic, you will massively change it until a point where it has nothing
85 to do with basic anymore. Unlike ZEN, basic is not intended to be use as a base theme for a
86 sub-theme (even though it is possible to do so). Because of this, it is not necessary to
87 update your theme when a new version of BASIC comes out. Always see Basic as a STARTER, and
88 as soon as you start using it, it is not BASIC anymore, but your own theme.
89
90 If you didn't rename your theme, but you don't want to be notified when basic has a new version
91 by the update module, simply delete "project = "basic" in basic.info
92
93 __________________________________________________________________________________________
94
95 Thanks for using BASIC, and remember to use the issue queue in drupal.org for any question
96 or bug report:
97
98 http://drupal.org/project/issues/basic
99
100 Current maintainers:
101 * Steve Krueger (SteveK) -http://drupal.org/user/111656 (http://thejibe.com)
102 * Niall Morgan (lil.destro) -https://drupal.org/user/597808 (http://thejibe.com)