readme.txt 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. === Blockbase ===
  2. Contributors: Automattic
  3. Requires at least: 5.7
  4. Tested up to: 5.7.2
  5. Requires PHP: 5.6.2
  6. License: GPLv2 or later
  7. License URI: http://www.gnu.org/licenses/gpl-2.0.html
  8. A starting point for building your block-based site.
  9. == Description ==
  10. Blockbase is a simple theme that supports full-site editing. It comes with a set of minimal templates and design settings that can be manipulated through Global Styles. Use it to build something beautiful.
  11. == About Blockbase ==
  12. The purpose of Blockbase is to provide a "ponyfill" that allows for 100% "configuration expression" of design. Any aspect of configurable design that Gutenberg does not yet take into account is expressed in theme.json 'custom' properties.
  13. To use this theme assign it as the parent theme and then copy from this them to the child theme the theme.json file and fill out the details.
  14. The goal is for the ponyfill styling to reflect what Gutenberg will style, from a given configuration, once that work is complete. But to offer that today, using simpler techniques that Gutenberg will use upon completion.
  15. == Building a Block Child Theme ==
  16. To build a Blockbase child theme follow these instructions:
  17. - Add a [package.json](https://github.com/Automattic/themes/blob/trunk/seedlet-blocks/package.json), [style.css](https://github.com/Automattic/themes/blob/trunk/seedlet-blocks/style.css) and empty index.php files to your theme.
  18. - Your child theme's theme.json file will be built by combining Blockbase's original theme.json file and your child's `child-theme.json`. That is the file where your configuration values live (you only want the values for variables that are different from the parent there). To generate the combined file, run `npm run build` from inside your theme's folder or run `npm run build:child child-theme-slug` from inside Blockbase's folder.
  19. - Extend the parent's templates that you want to customize or add new ones where needed following the [template hierarchy](https://themeshaper.com/2020/12/18/getting-started-with-block-themes-templates/).
  20. - Using `npm run start` will both watch changes inside the `sass` and `assets` folder and changes to the `child-theme.json` file.
  21. == Building a Universal Child Theme ==
  22. A Universal theme is a theme that works in Full Site Editing and in the Customizer. This is a concept that's still being explored so we don't have instructions to provide yet. If you are curious, you can visit [the project](https://github.com/Automattic/themes/tree/trunk/quadrat) where we are developing Quadrat as a Universal Theme.
  23. == Changelog ==
  24. = 1.1.0 =
  25. * Added color customization from the customizer
  26. = 1.0.1 =
  27. * Add skiplinks to post content
  28. * Remove unneeded functions to pass theme check
  29. = 1.0 =
  30. * Initial release
  31. == Copyright ==
  32. Blockbase WordPress Theme, (C) 2021 Automattic, Inc.
  33. Blockbase is distributed under the terms of the GNU GPL.
  34. This program is free software: you can redistribute it and/or modify
  35. it under the terms of the GNU General Public License as published by
  36. the Free Software Foundation, either version 2 of the License, or
  37. (at your option) any later version.
  38. This program is distributed in the hope that it will be useful,
  39. but WITHOUT ANY WARRANTY; without even the implied warranty of
  40. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  41. GNU General Public License for more details.
  42. Blockbase uses the following third-party resources:
  43. The Water Fan, by Winslow Homer
  44. License: CC0
  45. Source: https://www.artic.edu/artworks/38666/the-water-fan
  46. Included in theme screenshot.