51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
## @jscad/amf-deserializer
|
|
|
|
> amf deserializer for the jscad project
|
|
|
|
[](https://badge.fury.io/js/%40jscad%2Famf-deserializer)
|
|
[](https://travis-ci.org/jscad/amf-deserializer)
|
|
|
|
## Overview
|
|
|
|
This deserializer converts raw amf data to jscad code (that can be evaluated to CSG/CAG).
|
|
|
|
## Table of Contents
|
|
|
|
- [Installation](#installation)
|
|
- [Usage](#usage)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
|
|
## Installation
|
|
|
|
```
|
|
npm install @jscad/amf-deserializer
|
|
```
|
|
|
|
## Usage
|
|
|
|
|
|
```javascript
|
|
const amfDeSerializer = require('@jscad/amf-deserializer')
|
|
|
|
const rawData = fs.readFileSync('PATH/TO/file.amf')
|
|
const csgData = amfDeSerializer(rawData)
|
|
|
|
```
|
|
|
|
|
|
## Contribute
|
|
|
|
For questions about the API, please contact the [User Group](https://plus.google.com/communities/114958480887231067224)
|
|
|
|
PRs accepted.
|
|
|
|
Small Note: If editing this README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
|
|
|
|
|
## License
|
|
|
|
[The MIT License (MIT)](./LICENSE)
|
|
(unless specified otherwise)
|