h5ai/README.md

110 lines
3 KiB
Markdown
Raw Normal View History

2011-06-24 16:18:44 -04:00
# h5ai v0.3.2   ·   a beautified Apache index
2011-06-23 14:35:28 -04:00
2011-06-11 14:39:42 -04:00
2011-06-23 17:27:20 -04:00
## Screenshots
2011-06-11 14:39:42 -04:00
2011-06-23 17:35:19 -04:00
<a href="http://github.com/lrsjng/h5ai/raw/master/resources/h5ai-v0.2.1-details.png" target="_blank">
2011-06-23 17:27:20 -04:00
<img src="http://github.com/lrsjng/h5ai/raw/master/resources/h5ai-v0.2.1-details.png" width="400px" alt="screenshot" title="screenshot" style="display: inline" />
2011-06-16 08:41:38 -04:00
</a>
2011-06-23 17:35:19 -04:00
&#160; &#160; &#160;
2011-06-23 17:27:20 -04:00
<a href="http://github.com/lrsjng/h5ai/raw/master/resources/h5ai-v0.2.1-icons.png" target="_blank">
<img src="http://github.com/lrsjng/h5ai/raw/master/resources/h5ai-v0.2.1-icons.png" width="400px" alt="screenshot" title="screenshot" style="display: inline" />
2011-06-16 08:41:38 -04:00
</a>
2011-06-11 14:39:42 -04:00
2011-06-23 17:27:20 -04:00
## Live example
2011-06-15 19:24:49 -04:00
View a [sample folder](http://repo.larsjung.de/h5ai-sample)
*(the files are all empty to save webspace)*
2011-06-23 17:27:20 -04:00
## Install
2011-06-11 14:39:42 -04:00
2011-06-23 15:01:08 -04:00
Everything you need is located in folder `target`.
2011-06-23 14:35:28 -04:00
* Copy folder `h5ai` to the web-root directory of your server or alternativly set an alias `/h5ai/` to
2011-06-17 13:02:21 -04:00
this folder.
2011-06-23 14:35:28 -04:00
* Add the content of file `dot.htaccess` to the `.htaccess` file inside the directory
2011-06-17 13:02:21 -04:00
you want to be styled (you might have to create this file). This directory and any subdirectories will be
styled by h5ai.
2011-06-23 15:01:08 -04:00
Optionally add `h5ai.header.html` and/or `h5ai.footer.html` files to any of the styled folders to [display
custom top or bottom sections](http://repo.larsjung.de/h5ai-sample/customize). The content of those files
will be wrapped by `<header>` and `<footer>` tags.
2011-06-15 19:24:49 -04:00
2011-06-23 17:27:20 -04:00
## Changelog
2011-06-15 19:24:49 -04:00
2011-06-24 16:18:44 -04:00
### v0.3.2
*2011-06-24*
* removed lib versions from file names
* added 'empty' indicator for icons view
2011-06-24 09:39:44 -04:00
### v0.3.1
*2011-06-24*
* refactored js
* added `folderClick` and `fileClick` callback hooks
* fixed .emtpy style
2011-06-23 14:35:28 -04:00
### v0.3
*2011-06-23*
* included build stuff, files previously found in the base directory are now located in folder `target`
* styles and scripts are now minified
* added Modernizr 2.0.4 for future use
* updated jQuery to version 1.6.1
2011-06-16 15:20:18 -04:00
### v0.2.3
*2011-06-17*
* more refactoring in main.js
2011-06-17 13:22:44 -04:00
* ~~added custom js support, and global includes~~ *removed, only custom top and bottom sections supported*
2011-06-16 15:20:18 -04:00
### v0.2.2
*2011-06-16*
* refactored a lot, added some comments
* included fixes from [NumEricR](http://github.com/NumEricR/h5ai)
* added top/bottom message support, only basicly styled
2011-06-15 19:24:49 -04:00
### v0.2.1
*2011-06-16*
* fixed croped filenames
* fixed missing .png extension in header
* added some color to the links
* added changelog
2011-06-16 15:20:18 -04:00
2011-06-15 19:24:49 -04:00
### v0.2
*2011-06-15*
* added icon view
2011-06-23 17:27:20 -04:00
## Author
2011-06-15 19:24:49 -04:00
2011-06-16 08:53:38 -04:00
[Lars Jung](http://larsjung.de)
2011-06-22 10:09:00 -04:00
[h5ai on github](http://github.com/lrsjng/h5ai)
2011-06-11 14:39:42 -04:00
2011-06-23 17:27:20 -04:00
## License
2011-06-11 14:39:42 -04:00
2011-06-23 14:35:28 -04:00
<a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a>
This project is licensed under the [CC BY-SA 3.0 License](http://creativecommons.org/licenses/by-sa/3.0/).
It is based on
[HTML5 Boilerplate](http://html5boilerplate.com),
[jQuery](http://jquery.com),
[Modernizr](http://www.modernizr.com) and
[Faenza icon set](http://tiheum.deviantart.com/art/Faenza-Icons-173323228),
please respect their rights.
2011-06-11 14:39:42 -04:00