Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add some info to README #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add some info to README #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,25 @@
npm install node-dlib
node-dlib
=========

Node wrapper for dlib with limited functionality.

Build on Debian/Ubuntu:

```bash
apt install -y libdlib-dev libgif-dev libpng-dev libjpeg-dev
npm i node-dlib
```

Basic usage:

```js
var dlib = require('node-dlib'),
faced = new dlib.FrontalFaceDetector();

faced.detect('frame.jpeg', (err, faces) => {
if (err) throw err;
faces.forEach(f => {
console.log('Face at', f.x, f.y);
});
});
```