<commit_before># WordPress Boilerplate

WPBP is a set of small tools to simplify setting up and working with WordPress.

## What's included

**Installation script for new sites**

A script to download and configure WP, automatically setting up keys for the WP backend, Git revision control and utilities to work with multiple environments.
The script is maintained in this project, but you run it from [http://get.wpbp.io/](). Further instructions below.

**Configuration files for new and existing sites**

Abstractions to the base WP configuration in `wp-config.php`, enabling the use of multiple environments for easier team collaboration and code portability (think development > staging > production), independent of database configuration.
Maintained at [cabgfx/wpbp-config][conf]

**Starter theme (IN PROGRESS)**

A basic starter theme, with a narrow focus on template organization and utility functions, **not** markup and styling. (A cross-breed of [Starkers][st] and [Roots][ro]).
Maintained at [cabgfx/wpbp-theme][theme]

[conf]: https://github.com/cabgfx/wpbp-config
[theme]: https://github.com/cabgfx/wpbp-theme
[st]: https://github.com/viewportindustries/starkers
[ro]: https://github.com/retlehs/roots

## Why should I use this?

Using these tools to set up new WP sites gives you:

**Automatic configuration of `wp-config.php`**

Installing new WP sites requires you to rename `wp-config-sample.php` and get a fresh set of security keys for the WP backend. WPBP handles that for you, automatically renaming the file and inserting a fresh set of keys, straight from [the online generator][gen]. Neat, huh?

[gen]: https://api.wordpress.org/secret-key/1.1/salt/

**Multiple environments**

Using WPBP, you (and your team) can develop locally on `localhost`, and deploy the same codebase to other locations, eg. `www.yoursite.com`, which is notoriously cumbersome, because of how WP sets up the hostname in the database. Additional details can be found in the [wpbp-config repo][conf].

**A helper for environment-specific stuff**

WPBP defines an additional constant, `WPBP_ENV`, which enables you to easily check what environment you're running in.

Example:
I usually don't want to include the Google Analytics script when I work locally, so here's what I do:

```php
<?php if (WPBP_ENV == 'production'): ?>
  <script> … </script>
<?php endif; ?>
```

**Git-ready project setup**

A template `.gitignore` is provided for you, so you don't have to manually ignore the core WP files. You just need to add your own themes/plugins etc., as you create them.<commit_msg>Update description of starter theme<commit_after># WordPress Boilerplate

WPBP is a set of small tools to simplify setting up and working with WordPress.

## What's included

**Installation script for new sites**

A script to download and configure WP, automatically setting up keys for the WP backend, Git revision control and utilities to work with multiple environments.
The script is maintained in this project, but you run it from [http://get.wpbp.io/](). Further instructions below.

**Configuration files for new and existing sites**

Abstractions to the base WP configuration in `wp-config.php`, enabling the use of multiple environments for easier team collaboration and code portability (think development > staging > production), independent of database configuration. Maintained at [cabgfx/wpbp-config][conf]

**Starter theme**

A slightly simplified version of [Roots][ro], a starter theme based on HTML5 Boilerplate & Twitter Bootstrap. Maintained at [cabgfx/wpbp-theme][theme]

[conf]: https://github.com/cabgfx/wpbp-config
[theme]: https://github.com/cabgfx/wpbp-theme
[st]: https://github.com/viewportindustries/starkers
[ro]: http://roots.io/

## Why should I use this?

Using these tools to set up new WP sites gives you:

**Automatic configuration of `wp-config.php`**

Installing new WP sites requires you to rename `wp-config-sample.php` and get a fresh set of security keys for the WP backend. WPBP handles that for you, automatically renaming the file and inserting a fresh set of keys, straight from [the online generator][gen]. Neat, huh?

[gen]: https://api.wordpress.org/secret-key/1.1/salt/

**Multiple environments**

Using WPBP, you (and your team) can develop locally on `localhost`, and deploy the same codebase to other locations, eg. `www.yoursite.com`, which is notoriously cumbersome, because of how WP sets up the hostname in the database. Additional details can be found in the [wpbp-config repo][conf].

**A helper for environment-specific stuff**

WPBP defines an additional constant, `WPBP_ENV`, which enables you to easily check what environment you're running in.

Example:
I usually don't want to include the Google Analytics script when I work locally, so here's what I do:

```php
<?php if (WPBP_ENV == 'production'): ?>
  <script> … </script>
<?php endif; ?>
```

**Git-ready project setup**

A template `.gitignore` is provided for you, so you don't have to manually ignore the core WP files. You just need to add your own themes/plugins etc., as you create them.
{'fraction_non_alphanumeric': 0.0924980361351139, 'fraction_numerical': 0.0009819324430479183, 'mean_word_length': 4.748306997742664, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 15, 'https://': 9, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '549222', 'n_tokens_mistral': 1407, 'n_tokens_neox': 1358, 'n_words': 678}