Skip to content

doc: add Node.js install instructions #367

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

Merged
mmarchini merged 1 commit into from
Aug 5, 2020
Merged

doc: add Node.js install instructions #367

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
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,26 @@ npm install -g llnode
llnode `which node` -c /path/to/core/dump
```

- Never install llnode with `sudo` as it can easily lead to errors during
installation and execution.
- For more details on starting llnode see the [Usage](#usage) section.
- To get started with the llnode commands see the [Commands](#commands) section.

## Install Instructions

### Prerequisites: Official, active Node.js version

`llnode` only supports currently active Node.js versions installed via official
channels. We recommend installing Node.js with [nvm](https://github.com/nvm-sh/nvm)
as it allows users to install global packages without `sudo` by default, and
it always installs the official executables from https://nodejs.org.

**Do not install Node.js from the default Ubuntu/Debian apt repositories (or from
the default repositories of other Linux distributions), llnode is not compatible
with Node.js installed that way**. If you still want to install Node.js via
`apt-get`, take a look at
[nodesource/distributions](https://github.com/nodesource/distributions).

### Prerequisites: Install LLDB and its Library

To use llnode you need to have the LLDB debugger installed. The recommended
Expand Down