caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

README.md: fix markdown issues

Browse Source
This commit is contained in:
Hugues Delorme 2015-04-01 16:07:00 +02:00
parent c60322e89b
commit 6d962f7035
1 changed files with 27 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@ -8,38 +8,42 @@ support for various CAD file formats (eg. STL)
GeomIO aims to be fast, portable (ISO-C90 conformance) and feature-rich. GeomIO aims to be fast, portable (ISO-C90 conformance) and feature-rich.
Main highlights: 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 * "Abstract" streams that does not tie the user to C stream (`FILE*`).
any kind of device can be used (memory, file, socket, ...) GeomIO provides a general stream structure based on callbacks, so that
* Operations can be easily aborted any kind of device can be used (memory, file, socket, ...)
* Buffering of input/ouput for efficient device usage * Operations can be easily aborted
* Available under the CeCILL-B license, which is fully BSD compatible * Buffering of input/ouput for efficient device usage
* Available under the CeCILL-B license, which is fully BSD compatible
Current version only supports STL file format (STereoLithgraphy). Support of Current version only supports STL file format (STereoLithgraphy). Support of
STL is complete: STL is complete:
* Binary(little/big endian) and ASCII formats
* Header data and "attribute byte count" for binary format * Binary(little/big endian) and ASCII formats
* Name of solid for ASCII format * Header data and "attribute byte count" for binary format
* Detection of the input data format * Name of solid for ASCII format
* Detection of the input data format
In addition, the STL module has the following advatanges: 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 * The user keeps its own geometry data structures, no conversion needed.
retrieval/creation of geometry data This reduces the effort so that the user just specifies callbacks for
* No dynamic memory allocations retrieval/creation of geometry data
* Extended support of OpenCascade's `StlMesh_Mesh` * No dynamic memory allocations
* Extended support of OpenCascade's `StlMesh_Mesh`
Building GeomIO 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/`) 1. For an out-of-source build, create a directory where the build will take
2. Call `cmake`, passing as argument the directory where is located place (say `build/`)
CMakeLists.txt 2. Call `cmake`, passing as argument the directory where is located
3. `(n)make` CMakeLists.txt
4. `(n)make install` 3. `(n)make`
4. `(n)make install`
Read CMakeLists.txt to figure out how to build debug and release libraries. Read CMakeLists.txt to figure out how to build debug and release libraries.
@ -52,7 +56,7 @@ How to report a bug
If you think you have found a bug in GeomIO, we would like to hear 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 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 Before reporting a bug, please use the bug-tracker's search functions
to see if the issue is already known. to see if the issue is already known.