Procházet zdrojové kódy

Minor adjustments to README.md about documentation

Stéphane Raimbault před 10 roky
rodič
revize
280bdbce45
1 změnil soubory, kde provedl 12 přidání a 3 odebrání
  1. 12 3
      README.md

+ 12 - 3
README.md

@@ -37,10 +37,10 @@ To install, just run the usual dance, `./configure && make install`. Run
 
 You can change installation directory with prefix option, eg. `./configure
 --prefix=/usr/local/`. You have to check that the installation library path is
-properly set up on your system (`/etc/ld.so.conf.d`) and library cache is up to
+properly set up on your system (*/etc/ld.so.conf.d*) and library cache is up to
 date (run `ldconfig` as root if required).
 
-The library provides a `libmodbus.pc` file to use with `pkg-config` to ease your
+The library provides a *libmodbus.pc* file to use with `pkg-config` to ease your
 program compilation and linking.
 
 If you want to compile with Microsoft Visual Studio, you need to install
@@ -48,11 +48,20 @@ If you want to compile with Microsoft Visual Studio, you need to install
 
 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.
+*./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`.
 
+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 also available [online](http://libmodbus.org/documentation).
+
 Testing
 -------