Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
Showing
2 changed files
with
97 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
###How to Contribute | ||
|
||
Before contributing for the first time, you must <a href="https://gist.github.com/OXID-Admin/6df6ed126d074a54507d">sign the Contributor License Agreement</a>. | ||
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. | ||
|
||
<b>Best practice</b>: | ||
* 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:<br> | ||
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:<br> | ||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,80 @@ | ||
# OXID responsive Theme | ||
|
||
Branch b-0.1 is for 5.3+<x<6.0 shop. | ||
##General Information | ||
|
||
Branch master is for 6.0+ shop. | ||
"Flow" is responsive theme for OXID eShop. | ||
|
||
##Branches | ||
|
||
Currently we have two main branches for "flow" theme: | ||
|
||
* Branch ``b-0.1`` is for 5.3+ (4.10+ in case of CE edition) < x < 6.0 shop. | ||
* Branch ``master`` is for 6.0+ shop. | ||
|
||
|
||
##Installation | ||
|
||
Checkout appropriate "flow" theme repository branch by your shop version to shop's | ||
``Application/views`` directory and link or copy theme's ``out/flow`` directory to shop's ``out/flow``: | ||
|
||
* Clone "flow" theme: | ||
|
||
``` | ||
cd <shopSourceDirectory> | ||
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 <shopSourceDirectory>/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. |