From d6376bed232178e14dded7a5343d9a4315dc7f1b Mon Sep 17 00:00:00 2001 From: Joyee Cheung Date: Mon, 30 Jan 2017 23:25:10 +0800 Subject: [PATCH] readme: include npm install instructions Include instructions on installation with npm. Also update the output of `help v8`. --- README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7fdd476e..2ef4a818 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,30 @@ Node.js v4.x-v6.x C++ plugin for [LLDB](http://lldb.llvm.org) - a next generatio https://asciinema.org/a/29589 -## Build instructions +## Install Instructions -### OS X +### Install with npm + +```bash +npm install llnode +``` + +To use a particular build of lldb, use the `--lldb_exe` option: + +```bash +npm install --lldb_exe=`which lldb-3.9` llnode +``` + +### Install with Homebrew (OS X) -Easy: ```bash brew install llnode ``` -Harder: +## Build Instructions + +### OS X + ```bash # Clone this repo git clone https://github.com/nodejs/llnode.git && cd llnode @@ -84,7 +98,14 @@ The following subcommands are supported: core file being debugged. There are scripts for generating this file on Linux and Mac in the scripts directory of the llnode repository. - findrefs -- Find all the objects that refer to the specified object. + findrefs -- Finds all the object properties which meet the search criteria. + The default is to list all the object properties that reference the specified value. + Flags: + + * -v, --value expr - all properties that refer to the specified JavaScript object (default) + * -n, --name name - all properties with the specified name + * -s, --string string - all properties that refer to the specified JavaScript string value + inspect -- Print detailed description and contents of the JavaScript value. Possible flags (all optional):