[DOC] update documentation and description

Author: dmh

Configuration/TypoScript/Library/plugin.themes.setupts

@@ -4,13 +4,13 @@
 # plugin.tx_themes {
 #     view {
 #         templateRootPaths {
-#             2700 = EXT:theme_t3kit/Resources/Private/Templates/
+#             2700 = EXT:subtheme_t3kit_template@!%/Resources/Private/Templates/
 #         }
 #         partialRootPaths {
-#             2700 = EXT:theme_t3kit/Resources/Private/Partials/
+#             2700 = EXT:subtheme_t3kit_template@!%/Resources/Private/Partials/
 #         }
 #         layoutRootPaths {
-#             2700 = EXT:theme_t3kit/Resources/Private/Layouts/
+#             2700 = EXT:subtheme_t3kit_template@!%/Resources/Private/Layouts/
 #         }
 #     }
 # }

Meta/theme.yaml

@@ -2,7 +2,7 @@
 title            : Subtheme t3kit template
 version          : 0.3.0
 description      :  |
-  Start new subtheme based on t3kit project.
+  subtheme_t3kit_template based on t3kit project.
 
 parentTheme:
   name: theme_t3kit
@@ -18,4 +18,5 @@ keywords:
 screenshots:
   -
     file           : EXT:subtheme_t3kit_template/Meta/Screenshots/screenshot.png
-    caption        : Subtheme t3kit
+    caption        : Subtheme t3kit template
+

Resources/Public/README.md

@@ -1,2 +1,2 @@
 Do not change files in `CSS` and `LESS` folders.
-Those folders are generating automaticaly by felayout `subtheme_t3kit_template/felayout_t3kit`
+Those folders are generating automaticaly by felayout `subtheme_t3kit_template/felayout`

ext_emconf.php

@@ -1,15 +1,5 @@
 <?php
 
-########################################################################
-# Extension Manager/Repository config file for ext "theme_t3kit".
-#
-# Auto generated 25-08-2011 21:37
-#
-# Manual updates:
-# Only the data in the array - everything else is removed by next
-# writing. "version" and "dependencies" must not be touched!
-########################################################################
-
 $EM_CONF[$_EXTKEY] = array(
     'title' => 'Subtheme t3kit template',
     'description' => 'TBD',

felayout/README.md

@@ -1,8 +1,6 @@
 # felayout
 
-Front-End layout for Subtheme t3kit template
-
-### [Contributing to t3kit](https://github.com/t3kit/t3kit/blob/master/CONTRIBUTING.md)
+## Front-End layout for Subtheme t3kit template
 
 ### Required dependencies:
 
@@ -11,20 +9,34 @@ Front-End layout for Subtheme t3kit template
 - [NPM](https://github.com/npm/npm) >=3.10.8
 - [Grunt-cli](http://gruntjs.com/) >=1.2.0 `npm install -g grunt-cli`
 
-### Installation:
-
-First, clone repo:
-```bash
-git clone git@github.com:t3kit/felayout_bluemountain.git
-```
+***
 
-Next, install NPM dependencies:
+### Install NPM dependencies:
 
 ```bash
+cd felayout
 npm install
 ```
 
-### Getting Started:
+***
+
+## `felayout` includes CSS and JS source files Subtheme project.
+
+1. `felayout` works closely with t3kit docker, so to start developing using felayout we need to [install and run t3kit using docker configuration](https://github.com/t3kit/t3kit#development)
+
+
+2. Next step we need disable default styling (CSS) and JS scripts in t3kit to be able to insert it (CSS/JS) dynamically from felayout_t3kit. For this, we need to change `FElayout mode` constant from `less` to `development`.
+   * TYPO3 BE -> tab `Themes` -> `Expert` -> `FElayout mode`
+
+3. Next step is to run local server (_proxied from t3kit TYPO3 installation_) `localhost:9001` wich includes all CSS/LESS/JS files (`subtheme_t3kit_template/felayout_t3kit/dev`) with livereloading. For this, we need to use command `grunt`.
+
+4. Last step. After all changes (CSS/LESS/JS) which you did in `felayout` you will need to compile FE files into `subtheme_t3kit_template/Resources/Public/css` or `subtheme_t3kit_template/Resources/Public/less` folder using comands: `grunt compileCss` or `grunt compileLess`. Also, keep in mind that these compilated files should be committed by separate commit with a message `update css/less` without any prefixes. [Commit messages without prefixes shouldn't go to changelog files](https://github.com/t3kit/t3kit/blob/master/CONTRIBUTING.md#labels). **Do not commit compilated files together with source files from `subtheme_t3kit_template/felayout_t3kit/dev`**
+
+
+
+### Grunt commands:
 
-- Run `grunt` to start static server with livereload `localhost:9001`
-- Run `grunt check` to check CSS/LESS/JS files according code conventions
+- Run `grunt` to start local server (_proxied from t3kit TYPO3 installation_) with livereload `localhost:9001`
+- Run `grunt check` to check CSS (.stylelintrc) and JS (JS standard) files according code conventions.
+- Run `grunt compileCss` or `grunt cc` to compile all Front-End service files plus **CSS** styling for **t3kit** needs and copy it to `subtheme_t3kit_template/Resources/Public/css` folder.
+- Run `grunt compileLess` or `grunt cl` to compile all Front-End service files plus **LESS** styling for **t3kit** needs, copy it to it to `subtheme_t3kit_template/Resources/Public/less` folder.

felayout/package.json

@@ -1,9 +1,8 @@
 {
-  "name": "felayout_t3kit",
-  "version": "2.0.0",
-  "description": "Front-End layout for theme_t3kit project",
+  "name": "felayout",
+  "version": "1.0.0",
+  "description": "Front-End layout for Subtheme t3kit template",
   "license": "MIT",
-  "repository": "t3kit/theme_t3kit",
   "scripts": {
     "test": "grunt check"
   },

readmeTemplate.md

@@ -0,0 +1,12 @@
+# subtheme_t3kit_template
+
+### subtheme_t3kit_template based on [**typo3 CMS**](https://typo3.org/) and [**t3kit project**](https://github.com/t3kit)
+
+***
+
+### [CHANGELOG](https://github.com/t3kit/subtheme_t3kit_template/blob/master/CHANGELOG.md)
+### [Contributing to t3kit](https://github.com/t3kit/t3kit/blob/master/CONTRIBUTING.md)
+
+***
+
+**Built on [subtheme_t3kit_template](https://github.com/t3kit/subtheme_t3kit_template) v<%= subthemet3kitTemplateVersion %>**