From 750829cf2c26afb7dc37fca57cb0d0d4c462f6dd Mon Sep 17 00:00:00 2001 From: Alex Skrypnyk Date: Thu, 9 Nov 2023 12:09:59 +1100 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++----------- 1 file changed, 24 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index cdd9961de..a6283103f 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,41 @@ -# CivicTheme - Development source site -Mono-repo used to maintain CivicTheme and accompanying modules that are automatically published to another repositories on release. +

+ + CivicTheme logo +

+

CivicTheme - Development source site

+ +

Mono-repo used to maintain CivicTheme and accompanying modules that are automatically published to another repositories on release.

+ +
+ +[![GitHub Issues](https://img.shields.io/github/issues/salsadigitalauorg/civictheme_source.svg)](https://github.com/salsadigitalauorg/civictheme_source/issues) +[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/salsadigitalauorg/civictheme_source.svg)](https://github.com/salsadigitalauorg/civictheme_source/pulls) +![GitHub release (latest by date)](https://img.shields.io/github/v/release/salsadigitalauorg/civictheme_source) [![CircleCI](https://circleci.com/gh/salsadigitalauorg/civictheme_source.svg?style=shield)](https://circleci.com/gh/salsadigitalauorg/civictheme_source) ![Drupal 10](https://img.shields.io/badge/Drupal-10-blue.svg) - +![LICENSE](https://img.shields.io/github/license/salsadigitalauorg/civictheme_source) [![RenovateBot](https://img.shields.io/badge/RenovateBot-enabled-brightgreen.svg?logo=renovatebot)](https://renovatebot.com) - [//]: # (DO NOT REMOVE THE BADGE BELOW. IT IS USED BY DREVOPS TO TRACK INTEGRATION) -[![DrevOps](https://img.shields.io/badge/DrevOps-develop-blue.svg)](https://github.com/drevops/drevops/tree/develop) +[![DrevOps](https://img.shields.io/badge/DrevOps-1.17.2-blue.svg)](https://github.com/drevops/drevops/tree/1.17.2) + +
+ +--- + +> [!IMPORTANT] +> For Drupal theme installation instructions into your site, see https://docs.civictheme.io/development/drupal-theme ## Local environment setup + - Make sure that you have latest versions of all required software installed: - [Docker](https://www.docker.com/) - [Pygmy](https://github.com/pygmystack/pygmy) - [Ahoy](https://github.com/ahoy-cli/ahoy) - Make sure that all local web development services are shut down (Apache/Nginx, Mysql, MAMP etc). - Checkout project repository (in one of the [supported Docker directories](https://docs.docker.com/docker-for-mac/osxfs/#access-control)). -- Authenticate with Lagoon - 1. Create an SSH key and add it to your account in the [Lagoon Dashboard](https://ui-lagoon-master.ch.amazee.io/). - 2. Copy `.env.local.default` to `.env.local`. - `pygmy up` - `ahoy build` @@ -50,12 +65,10 @@ Copy `docker-compose.override.default.yml` to `docker-compose.override.yml`. ## More about CivicTheme +- [Documentation](https://docs.civictheme.io/) - [CivicTheme UI kit](https://github.com/salsadigitalauorg/civictheme_library) - [CivicTheme Drupal theme](https://www.drupal.org/project/civictheme) - [Default content for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_content) - [Admin adjustments for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_admin) - [GovCMS adjustments for CivicTheme Drupal theme](https://github.com/salsadigitalauorg/civictheme_govcms) ---- - -For additional information, please refer to the [Documentation site](https://docs.civictheme.io/)