gerber-to-svg - npm Package Compare versions

Comparing version 4.0.0-next.8 to 4.0.0-next.9

CHANGELOG.md

		@@ -6,2 +6,11 @@ # Change Log

		<a name="4.0.0-next.9"></a>
		# [4.0.0-next.9](https://github.com/tracespace/tracespace/compare/v4.0.0-next.8...v4.0.0-next.9) (2018-06-19)

		Note: Version bump only for package gerber-to-svg





		<a name="4.0.0-next.8"></a>
		@@ -8,0 +17,0 @@ # [4.0.0-next.8](https://github.com/tracespace/tracespace/compare/v4.0.0-next.7...v4.0.0-next.8) (2018-06-16)

package.json

		{
		"name": "gerber-to-svg",
		"version": "4.0.0-next.8",
		"description": "Render Gerber and NC drill files as SVGs in Node and the browser",
		"version": "4.0.0-next.9",
		"description": "Render individual Gerber / NC drill files as SVGs",
		"main": "lib/gerber-to-svg.js",
		@@ -43,4 +43,4 @@ "bin": {
		"escape-html": "^1.0.3",
		"gerber-parser": "^4.0.0-next.8",
		"gerber-plotter": "^4.0.0-next.8",
		"gerber-parser": "^4.0.0-next.9",
		"gerber-plotter": "^4.0.0-next.9",
		"inherits": "^2.0.1",
		@@ -47,0 +47,0 @@ "lodash.isfinite": "^3.2.0",

README.md

		@@ -5,6 +5,15 @@ # gerber to svg

		> Render Gerber and NC drill files as SVGs in Node and the browser
		> Render individual Gerber / NC drill files as SVGs

		`gerber-to-svg` is a library and CLI tool for converting [Gerber][gerber] and [NC drill][nc-drill] files (manufacturing files for printed circuit boards) into [SVG][svg] files for the web.

		Part of the [tracespace][] collection of PCB visualization tools.

		[tracespace]: https://github.com/tracespace/tracespace
		[npm]: https://www.npmjs.com/package/gerber-to-svg
		[npm-badge]: https://img.shields.io/npm/v/gerber-to-svg.svg?style=flat-square&maxAge=86400
		[gerber]: https://en.wikipedia.org/wiki/Gerber_format
		[nc-drill]: https://en.wikipedia.org/wiki/Excellon_format
		[svg]: https://en.wikipedia.org/wiki/Scalable_Vector_Graphics

		## install
		@@ -14,3 +23,3 @@
		npm install --save gerber-to-svg
		// or
		# or
		yarn add gerber-to-svg
		@@ -28,4 +37,8 @@ ```

		![arduino uno sol][sol]

		Arduino Uno design files used here under the terms of the [Creative Commons Attribution Share-Alike license](https://www.arduino.cc/en/Main/FAQ).

		[sol]: https://unpkg.com/gerber-to-svg@next/example/arduino-uno.sol.svg

		## usage
		@@ -44,28 +57,28 @@

		1. `npm install -g gerber-to-svg` or `yarn global add gerber-to-svg`
		2. `gerber-to-svg [options] -- gerber_files`
		1. `npm install -g gerber-to-svg` or `yarn global add gerber-to-svg`
		2. `gerber-to-svg [options] -- gerber_files`

		#### options

		switch \| description \| type
		---------------------- \| ------------------------------------------- \| -----------
		-o, --out \| output directory \| string
		-q, --quiet \| do not print warnings and messages \| boolean
		-p, --pretty \| pretty print output \| boolean, tab-size
		-a, --attr \| SVG attributes (e.g. --attr.color=blue) \| {[string]: string}
		-e, --append-ext \| append, rather than replace, .svg extension \| boolean
		-f, --format \| coordinate decimal places format \| "$int,$dec"
		-z, --zero \| override zero suppression \| "L", "T"
		-u, --units \| set backup units to \| "mm", "in"
		-n, --notation \| set backup absolute/incremental notation \| "A", "I"
		-t, --optimize-paths \| optimize and deduplicate paths \| boolean
		-b, --plot-as-outline \| optimize paths and fill gaps \| boolean, max-gap
		-v, --version \| display version information \| boolean
		-h, --help \| display this help text \| boolean
		\| switch \| description \| type \|
		\| --------------------- \| ------------------------------------------- \| ------------------ \|
		\| -o, --out \| output directory \| string \|
		\| -q, --quiet \| do not print warnings and messages \| boolean \|
		\| -p, --pretty \| pretty print output \| boolean, tab-size \|
		\| -a, --attr \| SVG attributes (e.g. --attr.color=blue) \| {[string]: string} \|
		\| -e, --append-ext \| append, rather than replace, .svg extension \| boolean \|
		\| -f, --format \| coordinate decimal places format \| "$int,$dec" \|
		\| -z, --zero \| override zero suppression \| "L", "T" \|
		\| -u, --units \| set backup units to \| "mm", "in" \|
		\| -n, --notation \| set backup absolute/incremental notation \| "A", "I" \|
		\| -t, --optimize-paths \| optimize and deduplicate paths \| boolean \|
		\| -b, --plot-as-outline \| optimize paths and fill gaps \| boolean, max-gap \|
		\| -v, --version \| display version information \| boolean \|
		\| -h, --help \| display this help text \| boolean \|

		#### examples:

		* `gerber-to-svg gerber.gbr` - convert gerber.gbr and output to stdout
		* `gerber-to-svg -o out gerber.gbr` - convert and output to out/gerber.svg
		* `gerber-to-svg -o out -a gerber.gbr` - output to out/gerber.gbr.svg
		* `gerber-to-svg gerber.gbr` - convert gerber.gbr and output to stdout
		* `gerber-to-svg -o out gerber.gbr` - convert and output to out/gerber.svg
		* `gerber-to-svg -o out -a gerber.gbr` - output to out/gerber.gbr.svg

		@@ -83,9 +96,1 @@ ## background
		Excellon / NC drill files do not have a completely clearly defined spec, so drill file parsing is lenient in its attempt to generate an image. It should auto-detect when a drill file has been entered. You may need to override parsing settings (see [API.md](./API.md)) to get drill files to render properly if they do not adhere to certain assumptions. The library must make these assumptions because Excellon does not define commands for certain formatting decisions.


		[npm]: https://www.npmjs.com/package/gerber-to-svg
		[npm-badge]: https://img.shields.io/npm/v/gerber-to-svg.svg?style=flat-square&maxAge=86400

		[gerber]: https://en.wikipedia.org/wiki/Gerber_format
		[nc-drill]: https://en.wikipedia.org/wiki/Excellon_format
		[svg]: https://en.wikipedia.org/wiki/Scalable_Vector_Graphics

example/arduino-uno.cmp.svg