Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
ryzy committed Nov 6, 2014
1 parent 49d3c20 commit fb8bb18
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
M12.Foundation
=============
# M12.Foundation - Foundation components inside TYPO3 Neos

TYPO3 Neos package implementing Foundation 5 elements.
M12.Foundation aims to implement all [Zurb Foundation](http://foundation.zurb.com/) components, in the best possible way, inside TYPO3 Neos CMS.

## Instalation
The best way is to install it together with [M12.FoundationSite](https://github.com/million12/M12.FoundationSite) Neos site package. It **conflicts with NeosDemoTypo3Org**, so remember to remove `typo3/neosdemotypo3org` dependency from your `composer.json`.

From command line (from Neos root directory) type:
## Usage

```composer require m12/neos-foundation:dev-master```
You can try ready-to-use [neos-typostrap-distribution](https://github.com/million12/neos-typostrap-distribution), TYPO3 Neos distribution which has this installed and configured.

**Alternatively**, you might add it manually to composer.json:
```
Alternatively, include in your main `composer.json` file:
``` json
"repositories": [
{ "type": "git", "url": "https://github.com/million12/M12.FoundationSite" }
],
"require": {
...
"m12/neos-foundation": "dev-master"
# standard dependencies here...
# "typo3/neosdemotypo3org": "x.y.z", # Remember to remove this one
"m12/neos-foundation": "dev-master",
"m12/neos-foundation-site": "dev-master"
},
```
and then execute `composer install`.
```
and run `composer install`

After all call:

```./flow flow:cache:flush --force && ./flow cache:warmup```
## Author(s)

* Marcin Ryzycki [email protected]
* Samuel Ryzycki [email protected]

0 comments on commit fb8bb18

Please sign in to comment.