Update notice and readme

master
Dmitry Baranovskiy 2013-09-09 11:16:25 +10:00
parent 4c609185c7
commit 5bca0ff9db
2 changed files with 30 additions and 7 deletions

12
NOTICE
View File

@ -4,7 +4,7 @@ Savage uses the following third party libraries that may have licenses
differing from that of Savage itself. You can find the libraries and their
respective licenses below.
- eve ./third-party/eve
- eve ./node_modules/eve
https://github.com/adobe-webplatform/eve/
@ -22,7 +22,7 @@ respective licenses below.
See the License for the specific language governing permissions and
limitations under the License.
- Mocha ./third-party/mocha
- Mocha ./node_modules/mocha
https://github.com/visionmedia/mocha/
@ -49,7 +49,7 @@ respective licenses below.
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Expect ./third-party/expect
- Expect ./node_modules/expect.js
https://github.com/LearnBoost/expect.js
@ -76,7 +76,7 @@ respective licenses below.
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Elemental ./third-party/elemental.js
- Elemental ./node_modules/elemental.js
https://github.com/DmitryBaranovskiy/elemental
@ -103,7 +103,7 @@ respective licenses below.
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- Grunt ./package.json (installed via NPM)
- Grunt ./node_modules/grunt
http://gruntjs.com
@ -128,4 +128,4 @@ respective licenses below.
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
OTHER DEALINGS IN THE SOFTWARE.

View File

@ -3,4 +3,27 @@ savage
JavaScript library for SVG.
API Reference is in `dist/reference.html`
API Reference is in `dist/reference.html`
### Building
Savage uses [Grunt](http://gruntjs.com/) to build
* Open the terminal from the Savage directory
cd savage
* Install its command line interface (CLI) globally
npm install -g grunt-cli
* Install dependencies with npm
npm install
_*Savage uses Grunt 0.4.0. You might want to [read](http://gruntjs.com/getting-started) more on their website if you havent upgraded since a lot has changed._
* Type `grunt` in the command line to build the files.
* The results will be built into the release folder.
* Alternatively type `grunt watch` to have the build run automatically when you make changes to source files.