Skip to content

Commit 7b2e7f5

Browse files
committed
Fixed headers
1 parent 05eeb97 commit 7b2e7f5

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

readme.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,24 @@
1-
admesh-parser
2-
=============
1+
# admesh-parser
32

43
[![Build Status](https://travis-ci.org/ArtskydJ/admesh-parser.svg?branch=master)](https://travis-ci.org/ArtskydJ/admesh-parser)
5-
[![Github Repository](http://img.shields.io/badge/Repository-Github-brightgreen.svg)](https://github.com/ArtskydJ/admesh-parser)
64

7-
- [Description](#description)
8-
- [You Can't Use This Until You Download More Stuff](#you-cant-use-this-until-you-download-more-stuff)
9-
- [Install](#install)
10-
- [Include](#include)
11-
- [admeshParser(options, cb)](#admeshparseroptions-cb)
12-
- [options](#options)
13-
- [cb(err, result)](#cberr-result)
14-
- [Example](#example)
15-
- [License](#license)
16-
17-
##Description
5+
# description
186

197
This module returns a function that takes an STL file and returns a JavaScript object containing information about the file.
208

21-
##You Can't Use This Until You Download More Stuff
9+
# you can't use this until you download more stuff
2210

2311
To use this module, you will need [admesh](https://sites.google.com/a/varlog.com/www/admesh-htm). This module just parses admesh's output, it does not include admesh. (Well, technically, it does, in the test folder, but it only will work for windows.)
2412

2513
You will also need an STL file to run this on. Two files are included in the 'test' folder.
2614

27-
##Install
15+
# install
2816

2917
Install with [NPM](http://nodejs.org)
3018

3119
npm install admesh-parser
3220

33-
##Include
21+
# api
3422

3523
```js
3624
var AdmeshParser = require('admesh-parser')
@@ -40,9 +28,9 @@ var admeshParser = new AdmeshParser('C:\\Users\\Me\\White space\\admesh.exe') //
4028
var admeshParser = new AdmeshParser('"C:\\Users\\Me\\White space\\admesh.exe"') //This should work even with the space. (Note the double quotes.)
4129
```
4230

43-
##admeshParser(options, cb)
31+
# `admeshParser(options, cb)`
4432

45-
###options
33+
### `options`
4634
Must be an `Array` or a `String`.
4735

4836
If it is a `string`, it must be the input file directory.
@@ -69,7 +57,7 @@ or
6957
var options = "C:\\Users\\Me\\Documents\\gear.stl"
7058
```
7159

72-
###cb(err, result)
60+
### `cb(err, result)`
7361

7462
- `err` is either `null`, or an `Error` object.
7563
- `result` is an object if there is not an error. It should look like the following:
@@ -94,7 +82,7 @@ var options = "C:\\Users\\Me\\Documents\\gear.stl"
9482
normalsFixed: 12 }
9583
```
9684

97-
##Example
85+
# example
9886

9987
```js
10088
var AdmeshParser = require('admesh-parser')
@@ -109,6 +97,6 @@ console.log("Num of facets, before: " + model.facets.overall.before)
10997
console.log("Volume: " + model.volume)
11098
```
11199

112-
##License
100+
# license
113101

114102
[MIT](http://opensource.org/licenses/MIT)

0 commit comments

Comments
 (0)