From 5e6f8cd3d4b974d1104a279fbf17ac8c8208ca1c Mon Sep 17 00:00:00 2001 From: Stéphane Raimbault Date: Wed, 11 Mar 2015 08:38:33 +0100 Subject: [PATCH] Minor adjustments to README about AsciiDoc --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6156db7..c0f16fb 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,17 @@ To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then select the common packages (gcc, automake, libtool, etc). The directory *./src/win32/* contains a Visual C project. -To compile under OS X with [homebrew](http://mxcl.github.com/homebrew/), you will need -to install the following dependencies first: `brew install autoconf automake libtool`. +To compile under OS X with [homebrew](http://mxcl.github.com/homebrew/), you +will need to install the following dependencies first: `brew install autoconf +automake libtool`. Documentation ------------- -The documentation can be generated in man pages and HTML files. The HTML files -aren't built by default by the `make` command but by`make htmldoc` in -*docs* directory. +The documentation is based on +[AsciiDoc](http://http://www.methods.co.nz/asciidoc/). Only man pages are built +by default with `make` command, you can run `make htmldoc` in *docs* directory +to generate HTML files. The documentation is also available [online](http://libmodbus.org/documentation). -- libgit2 0.21.4