Update readme.

This commit is contained in:
Lars Jung 2014-07-27 16:49:41 +02:00
parent 49603c6f80
commit 551da05c6c
5 changed files with 27 additions and 201 deletions

3
.gitignore vendored
View File

@ -1,6 +1,5 @@
*.sublime-*
build
local
*.sublime-*
test

View File

@ -1,19 +0,0 @@
Copyright (c) 2014 Lars Jung, http://larsjung.de
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT 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.

View File

@ -5,7 +5,6 @@ create [a new issue](https://github.com/lrsjng/h5ai/issues/new) on GitHub!
## Install
**Note:** please don't use files from the `src` folder for installation,
they need to be preprocessed to work correctly!
You'll find a preprocessed package, as well as detailed installation
@ -13,11 +12,10 @@ instructions on the [project page](http://larsjung.de/h5ai/).
## Build
There are repositories for the latest [releases](http://release.larsjung.de/h5ai/) and [dev builds](http://release.larsjung.de/h5ai/dev/).
But if you want to build **h5ai** yourself you need to install the build tool [fQuery](http://larsjung.de/fquery/) first:
> npm install -g fquery
> npm install -g fquery@0.11.0
This will install fQuery and its command line tool `makejs`. Run `makejs --help` to see if everything
worked fine. To clone and build the project run the following commands.
@ -29,10 +27,31 @@ You'll find a new directory `build` including a fresh zipball.
## License
The MIT License (MIT)
**h5ai** is provided under the terms of the [MIT License](https://github.com/lrsjng/h5ai/blob/develop/LICENSE.md).
Copyright (c) 2014 Lars Jung (http://larsjung.de)
It profits from these great projects:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT 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.
## References
**h5ai** profits from these great projects:
[Evolvere Icon Theme](http://franksouza183.deviantart.com/art/Evolvere-Icon-theme-440718295) (CC BY-NC-ND 3.0),
[Faenza Icons](http://tiheum.deviantart.com/art/Faenza-Icons-173323228) (GPL),
[Gnome Symbolic Icon Theme](https://git.gnome.org/browse/gnome-icon-theme-symbolic/) (CC BY-SA 3.0),

View File

@ -1,173 +0,0 @@
0 info it worked if it ends with ok
1 verbose cli [ '/usr/bin/node', '/usr/bin/npm', 'install', '-g', 'fquery' ]
2 info using npm@1.4.14
3 info using node@v0.10.29
4 verbose node symlink /usr/bin/node
5 verbose cache add [ 'fquery', null ]
6 verbose cache add name=undefined spec="fquery" args=["fquery",null]
7 verbose parsed url { protocol: null,
7 verbose parsed url slashes: null,
7 verbose parsed url auth: null,
7 verbose parsed url host: null,
7 verbose parsed url port: null,
7 verbose parsed url hostname: null,
7 verbose parsed url hash: null,
7 verbose parsed url search: null,
7 verbose parsed url query: null,
7 verbose parsed url pathname: 'fquery',
7 verbose parsed url path: 'fquery',
7 verbose parsed url href: 'fquery' }
8 silly lockFile 9a7368bb-fquery fquery
9 verbose lock fquery /home/lars/.npm/cache/9a7368bb-fquery.lock
10 silly lockFile 9a7368bb-fquery fquery
11 silly lockFile 9a7368bb-fquery fquery
12 verbose addNamed [ 'fquery', '' ]
13 verbose addNamed [ null, '*' ]
14 silly lockFile e5526921-fquery fquery@
15 verbose lock fquery@ /home/lars/.npm/cache/e5526921-fquery.lock
16 silly addNameRange { name: 'fquery', range: '*', hasData: false }
17 verbose url raw fquery
18 verbose url resolving [ 'https://registry.npmjs.org/', './fquery' ]
19 verbose url resolved https://registry.npmjs.org/fquery
20 info trying registry request attempt 1 at 18:48:33
21 http GET https://registry.npmjs.org/fquery
22 http 200 https://registry.npmjs.org/fquery
23 silly registry.get cb [ 200,
23 silly registry.get { date: 'Tue, 01 Jul 2014 16:48:33 GMT',
23 silly registry.get server: 'CouchDB/1.5.0 (Erlang OTP/R16B03)',
23 silly registry.get etag: '"DFHDQXLRHLZ7Y1EXB5YI3U9MI"',
23 silly registry.get 'content-type': 'application/json',
23 silly registry.get 'cache-control': 'max-age=30',
23 silly registry.get 'content-length': '29084',
23 silly registry.get 'accept-ranges': 'bytes',
23 silly registry.get via: '1.1 varnish',
23 silly registry.get age: '0',
23 silly registry.get 'x-served-by': 'cache-fra1220-FRA',
23 silly registry.get 'x-cache': 'MISS',
23 silly registry.get 'x-cache-hits': '0',
23 silly registry.get 'x-timer': 'S1404233313.482664,VS0,VE367',
23 silly registry.get vary: 'Accept',
23 silly registry.get 'keep-alive': 'timeout=10, max=50',
23 silly registry.get connection: 'Keep-Alive' } ]
24 silly addNameRange number 2 { name: 'fquery', range: '*', hasData: true }
25 silly addNameRange versions [ 'fquery',
25 silly addNameRange [ '0.1.0',
25 silly addNameRange '0.2.0',
25 silly addNameRange '0.3.0',
25 silly addNameRange '0.4.0',
25 silly addNameRange '0.5.0',
25 silly addNameRange '0.6.0',
25 silly addNameRange '0.7.0',
25 silly addNameRange '0.8.0',
25 silly addNameRange '0.8.1',
25 silly addNameRange '0.9.0',
25 silly addNameRange '0.10.0',
25 silly addNameRange '0.11.0' ] ]
26 verbose addNamed [ 'fquery', '0.11.0' ]
27 verbose addNamed [ '0.11.0', '0.11.0' ]
28 silly lockFile c56ebe5c-fquery-0-11-0 fquery@0.11.0
29 verbose lock fquery@0.11.0 /home/lars/.npm/cache/c56ebe5c-fquery-0-11-0.lock
30 silly lockFile 2abe8ce0-mjs-org-fquery-fquery-0-11-0-tgz https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
31 verbose lock https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz /home/lars/.npm/cache/2abe8ce0-mjs-org-fquery-fquery-0-11-0-tgz.lock
32 verbose addRemoteTarball [ 'https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz',
32 verbose addRemoteTarball '034d7d4e233586f742975b2ced7b27d2fdbeba70' ]
33 info retry fetch attempt 1 at 18:48:34
34 verbose fetch to= /tmp/npm-21334-KPbVeGat/registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
35 http GET https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
36 http 200 https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
37 silly lockFile 2abe8ce0-mjs-org-fquery-fquery-0-11-0-tgz https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
38 silly lockFile 2abe8ce0-mjs-org-fquery-fquery-0-11-0-tgz https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz
39 silly lockFile c56ebe5c-fquery-0-11-0 fquery@0.11.0
40 silly lockFile c56ebe5c-fquery-0-11-0 fquery@0.11.0
41 silly lockFile e5526921-fquery fquery@
42 silly lockFile e5526921-fquery fquery@
43 silly resolved [ { name: 'fquery',
43 silly resolved displayName: 'fQuery',
43 silly resolved version: '0.11.0',
43 silly resolved description: 'file selection and processing for node',
43 silly resolved url: 'http://larsjung.de/fquery/',
43 silly resolved keywords:
43 silly resolved [ 'file',
43 silly resolved 'tool',
43 silly resolved 'preprocessor',
43 silly resolved 'less',
43 silly resolved 'css',
43 silly resolved 'lesscss',
43 silly resolved 'js',
43 silly resolved 'javascript' ],
43 silly resolved author: { name: 'Lars Jung', email: 'lrsjng@gmail.com' },
43 silly resolved license: 'MIT',
43 silly resolved repository: { type: 'git', url: 'https://github.com/lrsjng/fQuery.git' },
43 silly resolved main: './lib/fQuery',
43 silly resolved bin: { makejs: './bin/makejs', wepp: './bin/wepp' },
43 silly resolved dependencies:
43 silly resolved { async: '~0.2.9',
43 silly resolved 'clean-css': '~1.0.12',
43 silly resolved commander: '~2.0.0',
43 silly resolved docco: '~0.6.2',
43 silly resolved glob: '~3.2.6',
43 silly resolved 'gzip-js': '~0.3.2',
43 silly resolved handlebars: '~1.0.12',
43 silly resolved jade: '~0.34.1',
43 silly resolved jshint: '~2.1.6',
43 silly resolved less: '~1.4.2',
43 silly resolved mkdirp: '~0.3.5',
43 silly resolved moment: '~2.1.0',
43 silly resolved mustache: '~0.7.2',
43 silly resolved rimraf: '~2.2.2',
43 silly resolved semver: '~2.0.11',
43 silly resolved 'uglify-js': '~2.3.6',
43 silly resolved underscore: '~1.5.1' },
43 silly resolved engines: { node: '>=0.8' },
43 silly resolved readme: '# fQuery\nFile selection and processing for Node.js. `makejs` and `wepp` included.\n\n* to report a bug or make a feature request please create [a new issue](https://github.com/lrsjng/fquery/issues/new).\n* website: <http://larsjung.de/fquery/>\n* sources: <https://github.com/lrsjng/fquery>\n\nfQuery is provided under the terms of the [MIT License](https://github.com/lrsjng/fquery/blob/develop/LICENSE.md).\n\n\n## Changelog\n\n\n### v0.11.0 - *2013-08-16*\n\n* adds `newerThan`\n* adds `spawnProcess`\n* adds `hash` plugin\n* removes `css-condensed`, `live` and `zip` plugin\n* adds lazy load for plugins\n* minor fixes\n\n\n### v0.10.0 - *2013-08-09*\n\n* moves `makejs` to a new tools section\n* integrates [wepp](http://larsjung.de/wepp/)\n* replaces `rmfr` with `DELETE`, no longer needs `I_AM_SURE`\n* adds uppercase methods `MOVE`, `COPY`, `WRITE` which overwrite existing files by default\n* adds `map` function\n\n\n### v0.9.0 - *2013-07-31*\n\n* fixes\n* updates `async` to `0.2.9`\n* updates `clean-css` to `1.0.12`\n* updates `commander` to `2.0.0`\n* updates `css-condense` to `0.0.6`\n* updates `docco` to `0.6.2`\n* updates `glob` to `3.2.6`\n* updates `handlebars` to `1.0.12`\n* updates `jade` to `0.34.1`\n* updates `jshint` to `2.1.6`\n* updates `less` to `1.4.2`\n* updates `mkdirp` to `0.3.5`\n* updates `moment` to `2.1.0`\n* updates `mustache` to `0.7.2`\n* updates `rimraf` to `2.2.2`\n* updates `semver` to `2.0.11`\n* updates `uglify-js` to `2.3.6`\n* updates `underscore` to `1.5.1`\n\n\n### v0.8.1 - *2012-09-15*\n\n* improves git plugin\n\n\n### v0.8.0 - *2012-09-13*\n\n* updates version method\n* updates git plugin\n\n\n### v0.7.0 - *2012-09-12*\n\n* adds header option to uglifyjs and cssmin plugin\n* adds cleancss plugin\n* adds csscondense plugin\n* adds githash plugin\n* adds shzip plugin\n* minor fixes\n\n\n### v0.6.0 - *2012-08-14*\n\n* adds linebreak option to uglifyjs and cssmin plugin\n\n\n### v0.5.0 - *2012-08-12*\n\n* adds globs in `includify`\n\n\n### v0.4.0 - *2012-08-11*\n\n* add plugin handlebars\n\n\n### v0.3.0 - *2012-08-05*\n\n* interface nearly done\n\n\n### v0.2.0 - *2012-07-26*\n\n* still initial changes\n\n\n### v0.1.0 - *2012-07-20*\n\n* initial release\n\n',
43 silly resolved readmeFilename: 'README.md',
43 silly resolved bugs: { url: 'https://github.com/lrsjng/fQuery/issues' },
43 silly resolved _id: 'fquery@0.11.0',
43 silly resolved dist:
43 silly resolved { shasum: '034d7d4e233586f742975b2ced7b27d2fdbeba70',
43 silly resolved tarball: 'http://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz' },
43 silly resolved _from: 'fquery@',
43 silly resolved _npmVersion: '1.3.5',
43 silly resolved _npmUser: { name: 'lrsjng', email: 'lrsjng@gmail.com' },
43 silly resolved maintainers: [ [Object] ],
43 silly resolved directories: {},
43 silly resolved _shasum: '034d7d4e233586f742975b2ced7b27d2fdbeba70',
43 silly resolved _resolved: 'https://registry.npmjs.org/fquery/-/fquery-0.11.0.tgz' } ]
44 info install fquery@0.11.0 into /usr/lib
45 info installOne fquery@0.11.0
46 info /usr/lib/node_modules/fquery unbuild
47 verbose tar unpack /home/lars/.npm/cache/fquery/0.11.0/package.tgz
48 silly lockFile f927d464-tar-usr-lib-node-modules-fquery tar:///usr/lib/node_modules/fquery
49 verbose lock tar:///usr/lib/node_modules/fquery /home/lars/.npm/cache/f927d464-tar-usr-lib-node-modules-fquery.lock
50 silly lockFile 8c765a20--cache-fquery-0-11-0-package-tgz tar:///home/lars/.npm/cache/fquery/0.11.0/package.tgz
51 verbose lock tar:///home/lars/.npm/cache/fquery/0.11.0/package.tgz /home/lars/.npm/cache/8c765a20--cache-fquery-0-11-0-package-tgz.lock
52 silly gunzTarPerm modes [ '755', '644' ]
53 error Error: EACCES, mkdir '/usr/lib/node_modules/fquery'
53 error { [Error: EACCES, mkdir '/usr/lib/node_modules/fquery']
53 error errno: 3,
53 error code: 'EACCES',
53 error path: '/usr/lib/node_modules/fquery',
53 error fstream_type: 'Directory',
53 error fstream_path: '/usr/lib/node_modules/fquery',
53 error fstream_class: 'DirWriter',
53 error fstream_stack:
53 error [ '/usr/lib/node_modules/npm/node_modules/fstream/lib/dir-writer.js:36:23',
53 error '/usr/lib/node_modules/npm/node_modules/mkdirp/index.js:37:53',
53 error 'Object.oncomplete (fs.js:107:15)' ] }
54 error Please try running this command again as root/Administrator.
55 error System Linux 3.13.0-30-generic
56 error command "/usr/bin/node" "/usr/bin/npm" "install" "-g" "fquery"
57 error cwd /home/lars/env/workspace/h5ai
58 error node -v v0.10.29
59 error npm -v 1.4.14
60 error path /usr/lib/node_modules/fquery
61 error fstream_path /usr/lib/node_modules/fquery
62 error fstream_type Directory
63 error fstream_class DirWriter
64 error code EACCES
65 error errno 3
66 error stack Error: EACCES, mkdir '/usr/lib/node_modules/fquery'
67 error fstream_stack /usr/lib/node_modules/npm/node_modules/fstream/lib/dir-writer.js:36:23
67 error fstream_stack /usr/lib/node_modules/npm/node_modules/mkdirp/index.js:37:53
67 error fstream_stack Object.oncomplete (fs.js:107:15)
68 verbose exit [ 3, true ]

View File

@ -2,8 +2,8 @@
"name": "h5ai",
"version": "0.25.2+",
"description": "a modern HTTP web server index",
"url": "http://larsjung.de/h5ai/",
"author": "Lars Jung",
"homepage": "http://larsjung.de/h5ai/",
"author": "Lars Jung <lrsjng@gmail.com> (http://larsjung.de)",
"license": "MIT",
"repository": {
"type": "git",