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

[ci_skip] Update README

Browse Source
This commit is contained in:
Hugues Delorme 2015-11-25 10:18:49 +01:00
parent 0c51d335ba
commit 27ac28cf6f
1 changed files with 15 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -17,15 +17,16 @@ C library for geometry input/output
gmio is a reusable C library whose purpose is to provide complete I/O gmio is a reusable C library whose purpose is to provide complete I/O
support for various CAD file formats (eg. STL) support for various CAD file formats (eg. STL)
gmio aims to be fast, portable (ISO-C90 conformance) and feature-rich. gmio aims to be [fast](https://github.com/fougue/gmio/wiki/4.-Benchmarks),
portable (ISO-C90 conformance) and feature-rich.
Main highlights: Main highlights:
* "Abstract" streams that does not tie the user to C stream (`FILE*`). * [x] "Abstract" streams that does not tie the user to C stream (`FILE*`).
gmio provides a general stream structure based on callbacks, so that gmio provides a general stream structure based on callbacks, so that
any kind of device can be used (memory, file, socket, ...) any kind of device can be used (memory, file, socket, ...)
* Operations can be easily aborted * [x] Operations can be easily aborted
* Buffering of input/ouput for efficient device usage * [x] Buffering of input/ouput for efficient device usage
* Available under the CeCILL-B license, which is fully BSD compatible * [x] Available under the CeCILL-B license, which is fully BSD compatible
Supported CAD files format Supported CAD files format
@ -33,19 +34,19 @@ Supported CAD files format
Current version only supports the STL file format (STereoLithography), but support is complete : Current version only supports the STL file format (STereoLithography), but support is complete :
* Binary(little/big endian) and ASCII formats * [x] Binary(little/big endian) and ASCII formats
* Header data and "attribute byte count" for binary format * [x] Header data and "attribute byte count" for binary format
* Name of solid for ASCII format * [x] Name of solid for ASCII format
* Detection of the input data format * [x] Detection of the input data format
* Ability to specify the text formatting to represent float values (ASCII formats) * [x] Ability to specify the text formatting to represent float values
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. * [x] The user keeps its own geometry data structures, no conversion needed.
This reduces the effort so that the user just specifies callbacks for This reduces the effort so that the user just specifies callbacks for
retrieval/creation of geometry data retrieval/creation of geometry data
* No dynamic memory allocations * [x] No dynamic memory allocations
* Extended support of OpenCascade's `StlMesh_Mesh` * [x] Extended support of OpenCascade's `StlMesh_Mesh`
Building gmio Building gmio
@ -53,17 +54,8 @@ Building gmio
gmio can be built with CMake, by default a static library is generated. gmio 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 Read the [Build instructions](https://github.com/fougue/gmio/wiki/2.-Build-instructions)
place (say `build/`)
2. Call `cmake`, passing as argument the directory where is located
CMakeLists.txt
3. `(n)make`
4. `(n)make install`
Read CMakeLists.txt to figure out how to build debug and release libraries.
For the first use of gmio, you should run unit tests:
`(n)make check`
How to report a bug How to report a bug