From 1c4bd534d0e52317f378eca48fae8dcee2c6686d Mon Sep 17 00:00:00 2001 From: Anton Fedurtsya Date: Fri, 8 Apr 2016 13:59:34 +0300 Subject: [PATCH] ESDEV-3533 Improved readme and add Contributing information Installation of flow theme is described in readme. Requirements for development are described in readme. Contributing file contains general information how to contribute anything new to flow repository. --- CONTRIBUTING.md | 20 +++++++++++++ README.md | 79 +++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 97 insertions(+), 2 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e50b355b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,20 @@ +###How to Contribute + +Before contributing for the first time, you must sign the Contributor License Agreement. +You can find more information about it on the FAQ page OXID Contribution and Contributor Agreement FAQ: +http://wiki.oxidforge.org/OXID_Contribution_and_Contributor_Agreement_FAQ + +First off, you have to fork current repository. + +Best practice: +* Please leave the the branch names as they are. +* If you want to fix a bug or develop a new feature, define an own branch in your repository. Name it e.g. "feature/foo" or "bug/bugname" for better traceability. +* Change whatever you want and send a pull request back to the original branch. + +For more information about this, please see:
+http://codeinthehole.com/writing/pull-requests-and-other-good-practices-for-teams-using-github/ + +You will find technical help with Git and GitHub on this place:
+https://help.github.com/ + +When sending your pull request, please provide a clear, meaningful and detailed information about what your code is about and what it will do, best including a screen shot if possible. \ No newline at end of file diff --git a/README.md b/README.md index d760344a..92baed51 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,80 @@ # OXID responsive Theme -Branch b-0.1 is for 5.3+ + git clone -b master https://github.com/OXID-eSales/flow_theme.git Application/views/flow + ``` + +* Link theme's ``out`` directory to shop: + + ``` + cd out + ln -s ../Application/views/flow/out/flow flow + ``` + Or copy theme's ``out`` directory to shop: + + ``` + cp -r Application/views/flow/out/flow out/flow + ``` + +* Activate theme in shop admin: + +Go to eShopAdmin->Extensions->Themes->Flow and Press "Activate" button. + +##Development + +All "flow" theme related ``css/javascript`` files can be found in theme's ``build`` directory, +For regenerating 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: + +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: + + ``` + curl -sL https://deb.nodesource.com/setup_5.x | sudo -E bash - + sudo apt-get install -y nodejs + ``` + +2. Install ``grunt`` globally. Example: + + ``` + sudo npm install -g grunt-cli + ``` + +3. Go to "flow" theme's directory and install all related ``grunt`` plugins: + + ``` + cd /Application/views/flow/ + sudo npm install + ``` + +4. Now its possible to regenerate "flow" theme assets by running ``grunt`` default +task while being in "flow" directory: + + ``` + grunt + ``` + +##Contributing + +If you are interested in contributing of some changes, Please read [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.