From 607159a61d061a168a40e8367bef9caefff6b11f Mon Sep 17 00:00:00 2001 From: Adrian Perez Date: Wed, 18 Jan 2012 00:31:22 +0200 Subject: [PATCH] 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. --- README.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index b67a749..622c284 100644 --- a/README.rst +++ b/README.rst @@ -5,13 +5,13 @@ Nginx Fancy Index module .. contents:: The Fancy Index module makes possible the generation of file listings, like -the built-in `autoindex `__ +the built-in `autoindex `__ 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: -* Custom headers. Either local or stored remotely (*working*). -* Custom footers. Either local or stored remotely (*working*). -* Add you own CSS style rules (*not yet implemented*). +* Custom headers. Either local or stored remotely. +* Custom footers. Either local or stored remotely. +* Add you own CSS style rules. This module is designed to work with Nginx_, a high performance open source web server written by `Igor Sysoev `__. @@ -19,13 +19,11 @@ server written by `Igor Sysoev `__. Requirements ============ -* Sources for Nginx_ 0.8.x, and its requirements. - - The module compiles with 0.7.x versions as well. - - - It _might_ compile with 0.6.x applying "nginx-0.6-support.patch", YMMV. - -* Patience, and some Coffee™. +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 +versions in the 0.6 series by applying ``nginx-0.6-support.patch``, but this +is unsupported (YMMV). Building @@ -44,7 +42,7 @@ Building ``--add-module`` flag pointing to the directory which contains the source of the fancy indexing module:: - $ cd nginx-0.6.6 + $ cd nginx-?.?.? $ ./configure --add-module=../nginx-fancyindex-?.?.? [extra desired options] 4. Build and install the software::