Merge pull request #29 from OXID-eSales/Wave-readme

Wave readme

CHANGELOG.md

@@ -4,14 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.0.1] -  unreleased
+## [1.0.2] -  unreleased
 
 ### Added
 
 ### Fixed
 
 ### Changed
 
+## [1.0.1] -  2019-01-22
+
+### Changed
+
+- Added information for theme development to README.md
+
 ## 1.0.0 -  2019-01-21
 
-[1.0.1]: https://github.com/OXID-eSales/wave-theme/compare/v1.0.0...HEAD
+[1.0.2]: https://github.com/OXID-eSales/wave-theme/compare/v1.0.1...HEAD
+[1.0.1]: https://github.com/OXID-eSales/wave-theme/compare/v1.0.0...v1.0.1

README.md

@@ -5,14 +5,17 @@
 *Wave* is a responsive theme for all OXID eShop editions.
 
 ## Installation
+If you want to extend the theme you need to clone the repository (see section development) as some soures are ignored on composer installation. 
+
 
 ### Step 1: Get the source code
 
+This step is only required if the theme is not delivered with the OXID distribution.
 ```
 composer require oxid-esales/wave-theme
 ```
 
-### Step 2: Prepare the database (< version 6.0 only)
+### Step 2: Prepare the database 
 
 In order to install the theme options, import the ``setup.sql`` (to be found in ``DOCUMENT_ROOT/source/Application/views/wave``) into your database.
 
@@ -32,6 +35,11 @@ Log into the admin panel, go to *Extensions → Themes → Wave* and press the *
 
 All *Wave* theme related CSS/Javascript files can be found in theme's ``build`` directory. To regenerate the theme's assets, the ``grunt`` tasks should be used. Please install ``grunt`` and run ``grunt's`` default task to regenerate all minimized ``css`` and ``js`` files:
 
+To get the development files you need to clone the repository
+
+	cd DOCUMENT_ROOT/Application/views/
+	git clone -b BRANCH_NAME https://github.com/OXID-eSales/wave-theme.git wave
+
 1. To use ``grunt``, ``npm`` is required. Check ``nodejs`` website for installation
 instructions (https://nodejs.org/en/download/package-manager/). Example of
 Installation on ubuntu system: