From d5f9eea24caac7bb995c1bbb12ef65ab4269cf78 Mon Sep 17 00:00:00 2001 From: "michael.danielczok" <michael@pcsg.de> Date: Sun, 9 Jan 2022 21:50:46 +0100 Subject: [PATCH] refactor: Documentation extended and translated to english. --- README.md | 22 ++++++++++++++-------- index.php | 3 --- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 03ab206..28391c7 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ QUIQQER Tailwind CSS ==================== +A QUIQQER Template to use with [TailwindCSS](https://tailwindcss.com/) framework. +This Template works with TailwindCSS up to version v0.7.4 +You can find documentations for v.0.7.4 [here - TailwindCSS documentation](https://tailwindcss-v0.netlify.app/docs/what-is-tailwind/). -Paketname: +Paket name: quiqqer/template-tailwindcss @@ -11,6 +14,10 @@ Paketname: Features -------- +- Support for TailwindCSS framework up to v0.7.4 +- Responsive design +- 5 standard template layouts +- an extra Landing Page layout (i.e. for product page) Installation @@ -34,11 +41,10 @@ Developer ### Install Tailwind CSS for developing -Standardmäßig beinhaltet das Template die von *Tailwind CSS* generierte Datei (`bin/css/style.css`). -Wenn du entwickeln möchtest, solltest du zunächst *Tailwind CSS* installieren (z.B. über NPM), deine Änderungen direkt -in der Input CSS Datei (`tailwind/tailwind.style.css`) oder in der Tailwind Config Datei (`tailwind/tailwind.config.js`) übernehmen -und die Output Datei (`bin/css/style.css`) neu generieren. Details dazu findest du in der offiziellen [Tailwind CSS Dokumentation](https://tailwindcss.com/docs/installation). - +By default, the template includes the file `bin/css/style.css` generated by *TailwindCSS*. +For developing you should install *Tailwind CSS* first (see instructions below). Make your changes in **input** CSS file `tailwind/tailwind.style.css` +or in Tailwind config file `tailwind/tailwind.config.js`. Then generate the **output** CSS file `bin/css/style.css`. +Details can be found in the official [*Tailwind CSS* manual](https://tailwindcss-v0.netlify.app//docs/installation) #### 1. Install *Tailwind CSS* via npm Install *Tailwind CSS* in tailwind folder in your template root directory: @@ -58,13 +64,13 @@ yarn add tailwindcss --dev You can find the config file in tailwind folder (`tailwind/tailwind.config.js`) in the template root directory. You don't have to generate new config file unless you want to start with default tailwind config file. -Further information about configuration you can find in the official [Tailwind CSS documentation - Configuration](https://tailwindcss.com/docs/configuration). +Further information about configuration you can find in the official [Tailwind CSS documentation - Configuration](https://tailwindcss-v0.netlify.app//docs/configuration). #### 3. Add or change components and utils If you want to change or add new components and utils, edit the tailwind style file (`tailwind/tailwind.style.css`). -You can find more information in the official [Tailwind CSS documentation - Use Tailwind in your CSS](https://tailwindcss.com/docs/installation#3-use-tailwind-in-your-css). +You can find more information in the official [Tailwind CSS documentation - Use Tailwind in your CSS](https://tailwindcss-v0.netlify.app//docs/installation#3-use-tailwind-in-your-css). #### 4. Generate new output css file diff --git a/index.php b/index.php index f04bba3..736f431 100644 --- a/index.php +++ b/index.php @@ -1,8 +1,5 @@ <?php -use QUI\Exception; -use QUI\System\Log; - $Locale = QUI::getLocale(); /** -- GitLab