From c2722641fdbca53cfd5dd0bda9130e7d493da094 Mon Sep 17 00:00:00 2001 From: Moe Date: Fri, 10 Apr 2020 09:31:40 -0700 Subject: [PATCH] Move "Face Training" section in README to below basic install --- plugins/face/README.md | 38 ++++++++++++++++++++------------------ 1 file changed, 20 insertions(+), 18 deletions(-) diff --git a/plugins/face/README.md b/plugins/face/README.md index 7585cdd0..c3d70076 100644 --- a/plugins/face/README.md +++ b/plugins/face/README.md @@ -24,6 +24,26 @@ pm2 start shinobi-face.js Doing this will reveal options in the monitor configuration. Shinobi does not need to be restarted when a plugin is initiated or stopped. +###Train Your Own Faces (Facial Recognition) + +> Currently this plugin loads faces upon plugin start + +1. Within the plugin's folder you will find a folder labelled `faces`. It will be empty. + ``` + ls faces + ``` +2. Create a folder with your name and put a JPEG image of your face inside it. The JPEG images must be photos of only you. The file structure may look like this. + ``` + faces/[HUMAN NAME]/[FILENAME] + faces/moe/1.jpg + faces/moe/2.jpg + faces/moe/3.jpg + ``` +3. Restart the plugin. + ``` + pm2 restart shinobi-face + ``` + ## Run the plugin as a Host > The main app (Shinobi) will be the client and the plugin will be the host. The purpose of allowing this method is so that you can use one plugin for multiple Shinobi instances. Allowing you to easily manage connections without starting multiple processes. @@ -71,21 +91,3 @@ Add the `plugins` array if you don't already have it. Add the following *object } ], ``` - -###Train Your Own Faces (Facial Recognition) - -1. Within the plugin's folder you will find a folder labelled `faces`. It will be empty. - ``` - ls faces - ``` -2. Create a folder with your name and put a JPEG image of your face inside it. The JPEG images must be photos of only you. The file structure may look like this. - ``` - faces/[HUMAN NAME]/[FILENAME] - faces/moe/1.jpg - faces/moe/2.jpg - faces/moe/3.jpg - ``` -3. Restart the plugin. - ``` - pm2 restart shinobi-face - ```