From 0a3d085c5a18cbfe3da3726e2db7e4e17576bccf Mon Sep 17 00:00:00 2001 From: Lars Jung Date: Thu, 14 May 2015 15:32:51 +0200 Subject: [PATCH] Update readme and changelog. --- CHANGELOG.md | 12 +++++++----- README.md | 21 +++++++++++++++++---- 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6baa572b..089514c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,17 @@ # Changelog * now requires PHP 5.4.0+ -* adds search +* changes index path to `/_h5ai/public/index.php` * lots of code cleanup and refactorings -* changes API +* adds frontend tests +* adds search +* adds wide links in tree view +* adds IE edge mode * fixes some styles in IE10 -* resets IE edge mode * fixes preview bottom bar for small screen widths -* use wide links in tree view +* changes API * updates build process -* updates `lodash` to 3.8.0 (adds debounce) +* updates `lodash` to 3.8.0 (adds debounce and trim) * updates h5bp styles to 5.1.0 * updates `normalize.css` to 3.0.3 * removes `Moment.js` diff --git a/README.md b/README.md index 6ee860bd..0c0e9f21 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,27 @@ In short you have to take the following two steps: There are installation ready packages for the latest [releases][release] and [dev builds][develop]. But to clone and build **h5ai** yourself run the following commands to find a fresh zipball in folder `build` (tested on linux -only, requires [`git`][git] and [`npm`][npm] to be installed). +only, requires [`git`][git] and [`node 0.12+`][node] to be installed). -~~~sh + +First install the global command line trigger for the [`mkr`][mkr] build tool: + +~~~ +> npm install -g mkr-global +~~~ + +Then run: + +~~~ > git clone git://github.com/lrsjng/h5ai.git > cd h5ai > npm install -> npm run build +> mkr release ~~~ +To build the frontend test suite run `mkr build-test`. This will output a +`file://`-URL you can look up in your browser to run the tests. + ## License @@ -70,7 +82,8 @@ too. Exceptions are the [Material Design icons][material-design-icons] (CC BY 4. [release]: http://release.larsjung.de/h5ai/ [develop]: http://release.larsjung.de/h5ai/develop/ [git]: http://git-scm.com -[npm]: https://www.npmjs.org +[node]: https://nodejs.org +[mkr]: http://larsjung.de/mkr/ [material-design-icons]: https://github.com/google/material-design-icons [license-img]: https://img.shields.io/badge/license-MIT-a0a060.svg?style=flat-square