electron
/
addon-tools-el
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

wip readme

This commit is contained in:
Luis Blanco 2019-08-05 17:14:11 +03:00
parent c548b29ecd
commit 688b7b08a9
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -92,9 +92,9 @@ would encourage you to abide by the following rules:
* Your binary directories are: * Your binary directories are:
* bin-win64 * bin-windows
* bin-linux64 * bin-linux
* bin-mac64 * bin-osx
* The following piece of code in your `index.js` without changes. Method `paths()` * The following piece of code in your `index.js` without changes. Method `paths()`
is described [here](#indexjs). is described [here](#indexjs).
@ -103,8 +103,6 @@ is described [here](#indexjs).
module.exports = require('addon-tools-raub').paths(__dirname); module.exports = require('addon-tools-raub').paths(__dirname);
``` ```
* Your whole **binding.gyp**:
<details> <details>
<summary>Show binding.gyp</summary> <summary>Show binding.gyp</summary>
@ -298,13 +296,11 @@ const core = require(`./${binPath}/MY_ADDON`);
## include/addon-tools.hpp ## include/addon-tools.hpp
There is a C++ header file, `addon-tools.hpp`, shipped with this package. It There is a C++ header file, `addon-tools.hpp`, shipped with this package. It
introduces several useful macros and utilities. Also it includes Nan automatically, introduces several useful macros and utilities. Also it includes Napi automatically,
so that you can replace: so that you can replace:
``` ```
// #include <v8.h> // already in node.h #include <napi.h>
// #include <node.h> // already in nan.h
#include <nan.h>
``` ```
with with
@ -318,8 +314,7 @@ As it was mentioned above, this can be done automatically. Also an actual path t
directory is exported from the module and is accessible like this: directory is exported from the module and is accessible like this:
``` ```
require('addon-tools-raub').include() // implicit console.log() require('addon-tools-raub').include // a string
require('addon-tools-raub').includePath // just a string
``` ```
Currently, there are following helpers in **addon-tools.hpp**: Currently, there are following helpers in **addon-tools.hpp**: