Update build instructions and formatting of the API section

This commit is contained in:
Alexandre Erwin Ittner 2010-09-05 23:38:41 -03:00
parent a80bed8045
commit 9511e04e61

24
README
View File

@ -22,21 +22,25 @@ Details on iconv may be obtained in the Open Group's interface definition
=== Download and installation === === Download and installation ===
Lua-iconv can be obtained from its LuaForge project page Lua-iconv can be obtained from its LuaForge project page
(http://luaforge.net/projects/lua-iconv/) or from some Linux distributions (http://luaforge.net/projects/lua-iconv/), from a LuaRocks server or from
which already provide it (eg. Debian). some Linux distributions which already provide it (eg. Debian).
Unless you downloaded a compiled package, you must build the library for Unless you downloaded a compiled package, you must build the library for
your system. If you are using a system with pkg-config (as many Linux your system. If you have LuaRocks installed, all the process is automatic;
distributions and Unix flavors) just fire up your favourite shell, untar just fire up your favourite shell and type, as root:
the distribution package and type, as root, within the program directory:
luarocks install lua-iconv
and the package will be downloaded from a rock server, installed and
configured. Otherwise, you must compile and install the package. In a system
with pkg-config (as many Linux distributions and Unix flavors) open a shell,
untar the distribution package and, within the program directory, type:
make install make install
The library will be compiled and installed on the in the correct path (which as root. The library will be compiled and installed on the in the correct
is defined in lua5.1.pc). path (which is defined in lua5.1.pc). Compiling on systems without pkg-config
requires manual changes in the Makefile (this includes Windows).
Compiling on systems without pkg-config requires manual changes in the
Makefile.