README.md: fix markdown issues

This commit is contained in:
Hugues Delorme 2015-04-01 16:07:00 +02:00
parent c60322e89b
commit 6d962f7035

View File

@ -8,6 +8,7 @@ support for various CAD file formats (eg. STL)
GeomIO aims to be fast, portable (ISO-C90 conformance) and feature-rich.
Main highlights:
* "Abstract" streams that does not tie the user to C stream (`FILE*`).
GeomIO provides a general stream structure based on callbacks, so that
any kind of device can be used (memory, file, socket, ...)
@ -17,12 +18,14 @@ Main highlights:
Current version only supports STL file format (STereoLithgraphy). Support of
STL is complete:
* Binary(little/big endian) and ASCII formats
* Header data and "attribute byte count" for binary format
* Name of solid for ASCII format
* Detection of the input data format
In addition, the STL module has the following advatanges:
* The user keeps its own geometry data structures, no conversion needed.
This reduces the effort so that the user just specifies callbacks for
retrieval/creation of geometry data
@ -33,7 +36,8 @@ In addition, the STL module has the following advatanges:
Building GeomIO
===============
GeomIO can be built with CMake, by default a shared library is generated.
GeomIO can be built with CMake, by default a static library is generated.
1. For an out-of-source build, create a directory where the build will take
place (say `build/`)
2. Call `cmake`, passing as argument the directory where is located
@ -52,7 +56,7 @@ How to report a bug
If you think you have found a bug in GeomIO, we would like to hear
about it so that we can fix it. The GeomIO bug tracking system is
open to the public at https://github.com/fougsys/fougtools/issues.
open to the public at https://github.com/fougsys/gmio/issues.
Before reporting a bug, please use the bug-tracker's search functions
to see if the issue is already known.