# arduino-lib-builder

> This project aims to simplify the (initial) development of new libraries for the Arduino platform.

Latest version **1.0.0** (published 2019-07-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install arduino-lib-builder
pnpm add arduino-lib-builder
yarn add arduino-lib-builder
bun add arduino-lib-builder
```

Provides the command `arduino-lib-builder`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-07-18 |
| First published | 2019-07-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 10.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | guilhermefarto |

## Links

- npm: https://www.npmjs.com/package/arduino-lib-builder
- npm.io page: https://npm.io/package/arduino-lib-builder

## Dependencies (7)

- [ncp](https://npm.io/package/ncp.md) ^2.0.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [figlet](https://npm.io/package/figlet.md) ^1.2.3
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.3
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.3
- [inquirer](https://npm.io/package/inquirer.md) ^6.5.0
- [replace-in-file](https://npm.io/package/replace-in-file.md) ^4.1.1

## Recent versions

- 1.0.0 (latest) — 2019-07-18

## README

# Arduino Lib Builder

This project aims to simplify the (initial) development of new libraries for the Arduino platform.

The official page for this project is: [https://github.com/guilhermefarto/arduino-lib-builder](https://github.com/guilhermefarto/arduino-lib-builder)

## Usage

* (i) Create an OS environment variable `"ARDUINO_HOME"` that points to the directory Arduino IDE installation directory;

* (ii) Copy the ["libraries-templates" directory](https://github.com/guilhermefarto/arduino-lib-builder/tree/master/libraries-templates) (from GitHub) to the root directory of the Arduino IDE;

* (iii) Install [Nodejs](https://nodejs.org/en/) (version equal or greater than v10.13.0)

* (iv) Install **`arduino-lib-builder`** package from NPM:

> `npm install -g arduino-lib-builder`

* (v) Execute **`arduino-lib-builder`**:

> `arduino-lib-builder`

* (vi) Fill in the information needed to build the new Arduino library;

## Additional information

1. After the new library is generated for the Arduino platform, the Visual Studio Code will be initialized based on the directory where the library was generated (_if Visual Studio Code is installed_);

2. The Arduino IDE will also be initialized;

## Dependencies

* npm install --save chalk figlet inquirer shelljs
* npm install --save ncp
* npm install --save replace-in-file
* npm install --save rimraf

## Contact / License

Feel free to contact me by mail: guilherme.farto@gmail.com

---
_Source: https://npm.io/package/arduino-lib-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._