jinql
/
ngx-fancyindex
mirror of https://github.com/aperezdc/ngx-fancyindex
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README with some bits 

More exactly:

* In the requirements section, state that the module will work with
  any version of Nginx newer than 0.7.x

* Updated URL to the Nginx wiki, using now wiki.nginx.org

* Specifying a custom CSS works, the README was contradicting the code.
  FWIW, removed status markers from features in the file.

* Made the build instructions a bit more generic.
pull/4/head
Adrian Perez 2012-01-18 00:31:22 +02:00
parent 44805008d0
commit 607159a61d
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.rst
View File

@ -5,13 +5,13 @@ Nginx Fancy Index module
.. contents:: .. contents::
The Fancy Index module makes possible the generation of file listings, like The Fancy Index module makes possible the generation of file listings, like
the built-in `autoindex <http://wiki.codemongers.com/NginxHttpAutoindexModule>`__ the built-in `autoindex <http://wiki.nginx.org/NginxHttpAutoindexModule>`__
module does, but adding a touch of style. This is possible because the module module does, but adding a touch of style. This is possible because the module
module allows a certain degree of customization of the generated content: module allows a certain degree of customization of the generated content:
* Custom headers. Either local or stored remotely (*working*). * Custom headers. Either local or stored remotely.
* Custom footers. Either local or stored remotely (*working*). * Custom footers. Either local or stored remotely.
* Add you own CSS style rules (*not yet implemented*). * Add you own CSS style rules.
This module is designed to work with Nginx_, a high performance open source web This module is designed to work with Nginx_, a high performance open source web
server written by `Igor Sysoev <http://sysoev.ru>`__. server written by `Igor Sysoev <http://sysoev.ru>`__.
@ -19,13 +19,11 @@ server written by `Igor Sysoev <http://sysoev.ru>`__.
Requirements Requirements
============ ============
* Sources for Nginx_ 0.8.x, and its requirements.
- The module compiles with 0.7.x versions as well. You will need the sources for Nginx_. Any version starting from the 0.7
series onwards will work. Note that the modules *might* compile with
- It _might_ compile with 0.6.x applying "nginx-0.6-support.patch", YMMV. versions in the 0.6 series by applying ``nginx-0.6-support.patch``, but this
is unsupported (YMMV).
* Patience, and some Coffee™.
Building Building
@ -44,7 +42,7 @@ Building
``--add-module`` flag pointing to the directory which contains the source ``--add-module`` flag pointing to the directory which contains the source
of the fancy indexing module:: of the fancy indexing module::
$ cd nginx-0.6.6 $ cd nginx-?.?.?
$ ./configure --add-module=../nginx-fancyindex-?.?.? [extra desired options] $ ./configure --add-module=../nginx-fancyindex-?.?.? [extra desired options]
4. Build and install the software:: 4. Build and install the software::