nick/npe_gerber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
Nick Playfair 2021-02-02 21:03:11 +00:00
parent abd380af50
commit 87a9e88948
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -10,24 +10,25 @@ Requires node version 10 or higher.
## Usage ## Usage
``` ```
const fileProc = require('@nplayfair/npe_gerber'); const { ImageGenerator } = require('@nplayfair/npe_gerber');
const folderConfig = { const folderConfig = {
tmpDir: path.join(__dirname, 'tmp'), tmpDir: path.join(__dirname, 'tmp'),
imgDir: path.join(__dirname, 'img') imgDir: path.join(__dirname, 'img')
} }
const config = { const imageConfig = {
// Refer to the sharp documentation for these values
resizeWidth: 600, resizeWidth: 600,
density: 1000, density: 1000,
compLevel: 1 compLevel: 1
} }
fileProc.config(folderConfig); const gerberArchive = '/path/to/gerber.zip';
let gerberArchive = '/path/to/gerber.zip'; const fileProc = new ImageGenerator(folderConfig, imageConfig);
fileProc.gerberToImage(gerberArchive, config, folderConfig.tmpDir, folderConfig.imgDir) fileProc.gerberToImage(gerberArchive)
.then(filename => { .then(filename => {
console.log(`Generated image ${filename}`); console.log(`Generated image ${filename}`);
}) })