Commit a577d462 authored by Tobias Jeger's avatar Tobias Jeger

ESSENTIALS-505: Update README and licensing.

parent c409f345
This diff is collapsed.
......@@ -10,13 +10,3 @@ Apache License Version 2.0. The licenses of some libraries might impose
different redistribution or general licensing terms than those stated in the
Apache License. Users and redistributors are hereby requested to verify these
conditions and agree upon them.
========================================================================================================================
Additional notice information is applicable for the following sub components:
------------------------------------------------------------------------------------------------------------------------
plugin-dashboard/src/main/webapp/components/hippo-plugins/**
Hippo Plugins
Copyright 2014 Hippo B.V. (http://www.onehippo.com)
......@@ -8,6 +8,50 @@ Please use the Hippo Essentials feedback form to inform us if you encounter any
suggestions for improvements.
```
# Prerequisites
* Java 8
* Maven 3.x
* Git (http://git-scm.com)
* NodeJS (http://nodejs.org/) 0.10+
* Node Package Manager (http://npmjs.org)
* Grunt (http://gruntjs.org)
* Bower (http://bower.io)
Grunt and Bower can be installed with Node Package Manager:
```shell
sudo npm install -g grunt-cli bower
```
If Bower fails to download zipped dependencies, make sure it uses decompress-zip >= 0.0.4.
(e.g. check the file /usr/lib/node_modules/bower/node_modules/decompress-zip/package.json,
and reinstall Bower if decompress-zip is too old).
## Windows specific preparation instructions
You can automate the installation of NodeJS and NPM using [Chocolatey package manager]
(https://chocolatey.org).
The package for Node.js can be installed using (this will also install NPM):
C:\> choco install nodejs.install
__Note:__ Due to a [bug] (http://jira.codehaus.org/browse/MEXEC-137) in the exec-maven-plugin the Maven build of the
API module will fail as the exec-maven-plugin is unable to find the __grunt__ and __bower__ commands. To fix this, do
the following:
* open folder `C:\Users\USER\AppData\Roaming\npm`
* copy __grunt.cmd__ to __grunt.bat__
* copy __bower.cmd__ to __bower.bat__
More information can be found [here] (http://stackoverflow.com/questions/22393785/exec-maven-plugin-says-cannot-run-specified-program-even-though-it-is-on-the-pa/22395703#22395703).
Installation of Git is also possible using Chocolatey:
C:\> choco install git.install
# Getting Started
## SVN checkout
......
......@@ -3,8 +3,18 @@
Additional notice information is applicable for the following sub components:
------------------------------------------------------------------------------------------------------------------------
components/hippo-plugins/**
components/hippo-theme/**
Hippo Plugins
Copyright 2014 Hippo B.V. (http://www.onehippo.com)
Hippo Theme
Copyright 2014-2015 Hippo B.V. (http://www.onehippo.com)
This product includes software developed by:
Hippo B.V., Amsterdam, The Netherlands (http://www.onehippo.com/);
The Apache Software Foundation (http://www.apache.org/).
NOTICE: Only our own original work is licensed under the terms of the
Apache License Version 2.0. The licenses of some libraries might impose
different redistribution or general licensing terms than those stated in the
Apache License. Users and redistributors are hereby requested to verify these
conditions and agree upon them.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment