Commit 280bdbce45f3b2a2596a58f8966789d57bacbf30
1 parent
333db8e1
Minor adjustments to README.md about documentation
Showing
1 changed file
with
12 additions
and
3 deletions
README.md
| @@ -37,10 +37,10 @@ To install, just run the usual dance, `./configure && make install`. Run | @@ -37,10 +37,10 @@ To install, just run the usual dance, `./configure && make install`. Run | ||
| 37 | 37 | ||
| 38 | You can change installation directory with prefix option, eg. `./configure | 38 | You can change installation directory with prefix option, eg. `./configure |
| 39 | --prefix=/usr/local/`. You have to check that the installation library path is | 39 | --prefix=/usr/local/`. You have to check that the installation library path is |
| 40 | -properly set up on your system (`/etc/ld.so.conf.d`) and library cache is up to | 40 | +properly set up on your system (*/etc/ld.so.conf.d*) and library cache is up to |
| 41 | date (run `ldconfig` as root if required). | 41 | date (run `ldconfig` as root if required). |
| 42 | 42 | ||
| 43 | -The library provides a `libmodbus.pc` file to use with `pkg-config` to ease your | 43 | +The library provides a *libmodbus.pc* file to use with `pkg-config` to ease your |
| 44 | program compilation and linking. | 44 | program compilation and linking. |
| 45 | 45 | ||
| 46 | If you want to compile with Microsoft Visual Studio, you need to install | 46 | 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 | @@ -48,11 +48,20 @@ If you want to compile with Microsoft Visual Studio, you need to install | ||
| 48 | 48 | ||
| 49 | To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then | 49 | To compile under Windows, install [MinGW](http://www.mingw.org/) and MSYS then |
| 50 | select the common packages (gcc, automake, libtool, etc). The directory | 50 | select the common packages (gcc, automake, libtool, etc). The directory |
| 51 | -`./src/win32/` contains a Visual C project. | 51 | +*./src/win32/* contains a Visual C project. |
| 52 | 52 | ||
| 53 | To compile under OS X with [homebrew](http://mxcl.github.com/homebrew/), you will need | 53 | To compile under OS X with [homebrew](http://mxcl.github.com/homebrew/), you will need |
| 54 | to install the following dependencies first: `brew install autoconf automake libtool`. | 54 | to install the following dependencies first: `brew install autoconf automake libtool`. |
| 55 | 55 | ||
| 56 | +Documentation | ||
| 57 | +------------- | ||
| 58 | + | ||
| 59 | +The documentation can be generated in man pages and HTML files. The HTML files | ||
| 60 | +aren't built by default by the `make` command but by`make htmldoc` in | ||
| 61 | +*docs* directory. | ||
| 62 | + | ||
| 63 | +The documentation is also available [online](http://libmodbus.org/documentation). | ||
| 64 | + | ||
| 56 | Testing | 65 | Testing |
| 57 | ------- | 66 | ------- |
| 58 | 67 |