xymp
/
exiv2
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #114 from D4N/readme_improvements

Browse Source 
Adapted README.md to better render on Github
v0.27.3
Luis Díaz Más 8 years ago committed by GitHub
parent 38584d938b 942044e7d9
commit 00f5b2ab6d
1 changed files with 56 additions and 53 deletions
Show Stats Download Patch File Download Diff File

109
README.md
Unescape Escape View File

@ -25,12 +25,13 @@ write Exif, IPTC and XMP image metadata. The homepage of Exiv2 is:
http://www.exiv2.org/ http://www.exiv2.org/
See doc/ChangeLog for a list of recent changes to Exiv2. See [doc/ChangeLog](https://github.com/Exiv2/exiv2/blob/master/doc/ChangeLog)
for a list of recent changes to Exiv2.
Exiv2 API and tag reference documentation is at http://www.exiv2.org/doc Exiv2 API and tag reference documentation is at http://www.exiv2.org/doc
or you can build it and point your browser to doc/index.html. or you can build it and point your browser to `doc/index.html`.
For more information on XMP support in Exiv2, see doc/README-XMP. For more information on XMP support in Exiv2, see [doc/README-XMP](https://github.com/Exiv2/exiv2/blob/master/doc/README-XMP).
Building and Installing Building and Installing
======================= =======================
@ -43,10 +44,11 @@ You can build the libraries in the following ways:
http://dev.exiv2.org/projects/exiv2/wiki/FAQ http://dev.exiv2.org/projects/exiv2/wiki/FAQ
2 Microsoft Visual C++ 2 Microsoft Visual C++
- see msvc/ReadMe.txt (32bit and 64bit builds Visual Studio 2005,08,10,12,13,15) - see [msvc/ReadMe.txt](https://github.com/Exiv2/exiv2/blob/master/msvc/ReadMe.txt) (32bit and 64bit builds Visual Studio 2005,08,10,12,13,15)
3 CMake (support for cmake on all platforms except MinGW) 3 CMake (support for cmake on all platforms except MinGW)
- see README-CMAKE for more information - see [README-CMAKE](https://github.com/Exiv2/exiv2/blob/master/README-CMAKE)
for more information
To build a commercial version of the Exiv2 library, see also section To build a commercial version of the Exiv2 library, see also section
"Commercial version" at the end of this file. "Commercial version" at the end of this file.
@ -60,7 +62,7 @@ build and install the library and utility:
$ sudo make install (Cygwin/MinGW $ make install) $ sudo make install (Cygwin/MinGW $ make install)
Caution: Caution:
If you downloaded the source code from the subversion repository, If you downloaded the source code from the git repository,
you will have to generate the configure script: you will have to generate the configure script:
$ make config $ make config
@ -72,10 +74,10 @@ To build the sample applications:
$ make samples $ make samples
The default install locations are /usr/local/lib for the library, The default install locations are `/usr/local/lib` for the library,
/usr/local/bin for the exiv2 utility and /usr/local/include/exiv2 for the `/usr/local/bin` for the `exiv2` utility and `/usr/local/include/exiv2` for the
header files. Use the --prefix=directory option of the configure script to header files. Use the `--prefix=directory` option of the configure script to
change the default. Run './configure --help' to see a list of all options. change the default. Run `./configure --help` to see a list of all options.
To uninstall Exiv2 from a UNIX-like system, run: To uninstall Exiv2 from a UNIX-like system, run:
@ -86,22 +88,22 @@ Dependencies
The following libexiv2 features are enabled by default and may*) The following libexiv2 features are enabled by default and may*)
require external libraries. They can be controlled through configure require external libraries. They can be controlled through configure
options. See also './configure --help'. options. See also `./configure --help`.
Feature Package Configure options Feature Package Configure options
-------------------------- -------- ---------------------------- -------------------------- -------- ----------------------------
PNG image support zlib --without-zlib PNG image support zlib --without-zlib
--with-zlib=DIR --with-zlib=DIR
Native language support gettext --disable-nls Native language support gettext --disable-nls
Characterset conversions libiconv --without-libiconv-prefix Characterset conversions libiconv --without-libiconv-prefix
--with-libiconv-prefix[=DIR] --with-libiconv-prefix[=DIR]
XMP support expat --disable-xmp XMP support expat --disable-xmp
--with-expat=DIR --with-expat=DIR
zlib http://zlib.net/ zlib http://zlib.net/
gettext *) http://www.gnu.org/software/gettext/ gettext *) http://www.gnu.org/software/gettext/
libiconv *) http://www.gnu.org/software/libiconv/ libiconv *) http://www.gnu.org/software/libiconv/
expat http://expat.sourceforge.net/ expat http://expat.sourceforge.net/
*) Some systems have gettext and iconv in libc. The configure script *) Some systems have gettext and iconv in libc. The configure script
should detect this. should detect this.
@ -111,32 +113,33 @@ package management system of the distribution together with the
corresponding development packages (for the header files and static corresponding development packages (for the header files and static
libraries). libraries).
To build the sample programs in the samples/ directory ('make samples'), To build the sample programs in the
you also need to have the pkg-config program. [samples/](https://github.com/Exiv2/exiv2/tree/master/samples)
directory (`make samples`), you also need to have the `pkg-config`
program.
To generate the documentation ('make doc'), you will further need To generate the documentation (`make doc`), you will further need
doxygen, graphviz, python and xsltproc. `doxygen`, `graphviz`, `python` and `xsltproc`.
pkg-config http://pkg-config.freedesktop.org/wiki/ pkg-config http://pkg-config.freedesktop.org/wiki/
doxygen http://www.doxygen.org/ doxygen http://www.doxygen.org/
graphviz http://www.graphviz.org/ graphviz http://www.graphviz.org/
python http://www.python.org/ python http://www.python.org/
xsltproc http://xmlsoft.org/XSLT/ xsltproc http://xmlsoft.org/XSLT/
md5sum http://www.microbrew.org/tools/md5sha1sum/ md5sum http://www.microbrew.org/tools/md5sha1sum/
Troubleshooting Troubleshooting
=============== ===============
If you have problems building Exiv2 on UNIX-like systems, check the If you have problems building Exiv2 on UNIX-like systems, check the
generated config/config.mk and config/config.h files. You should *not* generated `config/config.mk` and `config/config.h` files. You should *not*
need to modify any Makefile directly, in particular not src/Makefile! need to modify any Makefile directly, in particular not `src/Makefile`!
Support Support
======= =======
All project resources are accessible from the project website at All project resources are accessible from the project website at
http://dev.exiv2.org/projects/exiv2/wiki
http://dev.exiv2.org/projects/exiv2/wiki
Please send feedback or queries to the Exiv2 forum. For new bug reports Please send feedback or queries to the Exiv2 forum. For new bug reports
and feature requests, please open an issue. and feature requests, please open an issue.
@ -145,24 +148,25 @@ Linking your own code with Exiv2
================================ ================================
A pkg-config .pc file is installed together with the library. A pkg-config .pc file is installed together with the library.
Application developers can use pkg-config(1) to obtain correct compile Application developers can use `pkg-config(1)` to obtain correct
and link time flags for the Exiv2 library. See samples/Makefile for an compile and link time flags for the Exiv2 library. See
example. [samples/Makefile](https://github.com/Exiv2/exiv2/blob/master/samples/Makefile)
for an example.
If you downloaded Exiv2 directly from the subversion repository, and If you downloaded Exiv2 directly from the git repository, and you want
you want to build it using the GNU configure script, then you need to to build it using the GNU configure script, then you need to have GNU
have GNU Autoconf installed on your system and create the configure Autoconf installed on your system and create the configure script as
script as the first step: the first step:
$ make config $ make config
Then run the usual './configure; make; make install' commands. Then run the usual `./configure; make; make install` commands.
Exiv2 uses GNU Libtool in order to build shared libraries on a variety Exiv2 uses GNU Libtool in order to build shared libraries on a variety
of systems. While this is very nice for making usable binaries, it can of systems. While this is very nice for making usable binaries, it can
be a pain when trying to debug a program. For that reason, compilation be a pain when trying to debug a program. For that reason, compilation
of shared libraries can be turned off by specifying the of shared libraries can be turned off by specifying the
--disable-shared option to the configure script. `--disable-shared` option to the configure script.
License License
======= =======
@ -192,11 +196,10 @@ the conversion of Nikon lens data to readable lens names to build a
commercial version of the Exiv2 library. commercial version of the Exiv2 library.
To do this on Windows, compile the library with the preprocessor To do this on Windows, compile the library with the preprocessor
symbol EXV_COMMERCIAL_VERSION defined in msvc\include\exv_msvc.h symbol `EXV_COMMERCIAL_VERSION` defined in `msvc\include\exv_msvc.h`
On UNIX-like systems, run the configure On UNIX-like systems, run the configure script with the options
script with the options --enable-commercial --disable-nls `--enable-commercial --disable-nls --disable-lensdata`.
--disable-lensdata.
# That's all Folks # That's all Folks
## ##

Write Preview
Loading…
Cancel
Save