~ubuntu-branches/ubuntu/raring/readosm/raring

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): David Paleino
  • Date: 2012-10-07 17:24:29 UTC
  • Revision ID: package-import@ubuntu.com-20121007172429-lv8oyiu086t7henm
Tags: upstream-1.0.0a+dfsg1
ImportĀ upstreamĀ versionĀ 1.0.0a+dfsg1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
ReadOSM is a simple library intended for extracting the contents from 
 
2
Open Street Map files: both input formats (.osm XML based and .osm.pbf
 
3
based on Google's Protocol Buffer serialization) are indifferenctly
 
4
supported.
 
5
 
 
6
 
 
7
Documentation
 
8
-------------
 
9
Documentation is generated using Doxygen. You can run "doxygen" in the top level
 
10
directory to generate HTML and LaTeX documentation (in the html/ and latex/
 
11
directories respectively). You can generate a PDF format manual if you go into
 
12
the latex/ directory and type "make". The output should be a file called
 
13
refman.pdf. The HTML documentation is normally more useful.
 
14
 
 
15
 
 
16
Coverage testing
 
17
----------------
 
18
ReadOSM has coverage testing support. You need to have gcov and lcov installed.
 
19
 
 
20
Process:
 
21
1. Use --enable-gcov=yes with configure script
 
22
2. Clean and rebuild.
 
23
3. make coverage-init
 
24
4. make check (or whatever other tests you want to check coverage for)
 
25
5. make coverage
 
26
6. check summary on command line output.
 
27
7. review detailed coverage results in covresults/index.html