diff --git a/README.md b/README.md index 699f844..67701b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # Bixal USWDS Drupal base theme @TODO document the process to create a new child theme from the starter_theme. + +## Install base theme by modifying composer.json file +Add bixal/bixaluswds to `repositories` object. +``` +{ + "type": "package", + "package": { + "name": "bixal/bixaluswds", + "version": "1.0", + "type":"drupal-theme", + "source": { + "url": "https://github.com/Bixal/bixaluswds.git", + "type": "git", + "reference": "v0.0.0" + } + } +} +``` +Run `lando composer install` + +## Initialize child theme using drupal theme generate function +Determine what theme name you want to use in this example we are using `my_new_theme`. +First create a `custom` directory in `themes` directory if there isn't one `mkdir web/themes/custom`. +``` +lando php web/core/scripts/drupal generate-theme --starterkit starter_theme my_new_theme --path themes/custom +lando drush cr +``` + +## Remove these lines from your custom theme info file +``` +hidden: true +starterkit: true +``` + +## Install the theme dependencies and set your custom theme as the default diff --git a/bixaluswds.info.yml b/bixaluswds.info.yml index 5346cf4..3a64322 100644 --- a/bixaluswds.info.yml +++ b/bixaluswds.info.yml @@ -1,9 +1,10 @@ -name: Bixal USWDS Base Theme +name: Bixal USWDS base theme type: theme description: "Drupal base theme for use with USWDS. Check the README for further instructions." -core_version_requirement: "^9.4 || ^10" +core_version_requirement: "^^10" base theme: false version: '0.0.0' +hidden: true dependencies: - drupal:twig_tweak - drupal:twig_field_value diff --git a/starter_theme/starter_theme.info.yml b/starter_theme/starter_theme.info.yml index aad1bb1..4a62b2d 100644 --- a/starter_theme/starter_theme.info.yml +++ b/starter_theme/starter_theme.info.yml @@ -1,7 +1,7 @@ -name: Bixal USWDS Theme +name: Bixal USWDS starter theme type: theme description: "Drupal theme for use with USWDS." -core_version_requirement: "^9.4 || ^10" +core_version_requirement: "^10" base theme: bixaluswds starterkit: true version: '0.0.0'