README.txt

   1
   2 Build Kit 2.x for Drupal 7.x
   3 ----------------------------
   4 Get started building with Drupal fast.
   5
   6 Build Kit is a basic distribution meant to capture elements that are generally
   7 useful and make building Drupal sites and Drupal distributions easier.
   8
   9 Build Kit helps site builders
  10
  11 - use install profiles and drush make for defining projects
  12 - manage the dev > staging > live workflow problem using Features and
  13   exportables
  14 - keep track of important upstream patches that are critical to Drupal
  15   distributions
  16
  17
  18 Requirements
  19 ------------
  20 In addition to the standard Drupal requirements you will need the following to
  21 make use of Build Kit:
  22
  23 - drush - http://drupal.org/project/drush
  24 - git - http://git-scm.com
  25
  26
  27 Getting started
  28 ---------------
  29 You can use drush to download Drupal core with the Build Kit installation
  30 profile.
  31
  32 1. `$ drush dl buildkit`
  33
  34 2. Choose the "Build Kit" install profile when installing Drupal
  35
  36
  37 Extending Build Kit
  38 -------------------
  39 Site builders can use Build Kit as a starting point for their own install
  40 profiles. Basic steps for creating a new install profile called `myprofile` that
  41 extends Build Kit:
  42
  43 1. Create the following directory and files:
  44
  45         profiles/myprofile
  46         profiles/myprofile/build-myprofile.make
  47         profiles/myprofile/myprofile.info
  48         profiles/myprofile/myprofile.make
  49         profiles/myprofile/myprofile.install
  50         profiles/myprofile/myprofile.profile
  51
  52 2. Enter an include statement into `build-myprofile.make` to include the
  53    contents of the Build Kit distro make file and then add your new install
  54    profile to it:
  55
  56        ; Include Drupal core and any core patches from Build Kit
  57        includes[] = http://drupalcode.org/project/buildkit.git/blob_plain/refs/heads/7.x-2.x:/drupal-org-core.make
  58
  59         ; Add myprofile to the full Drupal distro build
  60         projects[myprofile][type] = profile
  61         projects[myprofile][download][type] = git
  62         projects[myprofile][download][url] = git://github.com/myname/myprofile.git
  63
  64 3. Enter an include statement into `myprofile.make` to include the contents of
  65    the Build Kit install profile makefile and then add any additional projects
  66    or overrides:
  67
  68         ; Include Build Kit install profile makefile via URL
  69         includes[] = http://drupalcode.org/project/buildkit.git/blob_plain/refs/heads/7.x-2.x:/drupal-org.make
  70
  71         projects[feeds][version] = 2.0-alpha1
  72         projects[job_scheduler][version] = 2.0-alpha1
  73         ...
  74
  75 4. Copy the contents of `buildkit.info` into `myprofile.info` and then adjust
  76   its contents to reflect the metadata, modules and theme you want to enable.
  77   For example:
  78
  79         name = My First Drupal Distro
  80         core = 7.x
  81         description = Hello world!
  82
  83         dependencies[] = feeds
  84         ...
  85
  86 5. Implement `hook_install()` in `myprofile.install` to do any other setup
  87   tasks for your install profile:
  88
  89         <?php
  90
  91         function myprofile_install() {
  92           theme_enable(array('stark'));
  93           variable_set('theme_default', 'stark');
  94         }
  95
  96 6. Build a full distro using the following command from the root of your
  97    project directory.
  98
  99         $ drush make --prepare-install --contrib-destination=profiles/myprofile profiles/myprofile/build-myprofile.make --yes
 100
 101 7. Choose "My First Drupal Distro" when installing Drupal!
 102
 103
 104 Current Maintainer
 105 ------------------
 106 Shawn Price (langworthy)
 107
 108 Past Maintainers
 109 ----------------
 110 - Alex Barth (alex_b)
 111 - Jeff Miccolis (jmiccolis)
 112 - Will White
 113 - Young Hahn (yhahn)