From c0669cb46e7524e0bb8c07443ac0ba21ee244814 Mon Sep 17 00:00:00 2001 From: Neil Craig Date: Thu, 27 Apr 2017 20:19:17 +0100 Subject: [PATCH] Update touch-bar.md Add a simple example of running the example code as it might not be obvious to people who've not used Electron. Hopefully it makes sense :-) --- docs/api/touch-bar.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api/touch-bar.md b/docs/api/touch-bar.md index 0a0827a2b2fa..371982fc2b47 100644 --- a/docs/api/touch-bar.md +++ b/docs/api/touch-bar.md @@ -138,3 +138,11 @@ app.once('ready', () => { window.setTouchBar(touchBar) }) ``` +### Running the above example +To run the example above, you'll need to (assuming you've got a terminal open in the dirtectory you want to run the example): + +1. Save the above file to your computer, named as touchbar.js +2. Install electron via e.g. `npm install electron` +3. Run the example inside electron: `./node_modules/.bin/electron touchbar.js` + +You should then see a new electron window and the app running in your touchbar (or touchbar emulator).