From 5c035fbdce36754465e7abda433b7fe03fa5081f Mon Sep 17 00:00:00 2001
From: Kenneth Geisshirt <geisshirt@gmail.com>
Date: Tue, 29 May 2018 18:06:15 +0200
Subject: [PATCH] How to debug (#1835)

* How to debug C++ code using VSCode.
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 7df524ff..7b150b3b 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,26 @@ npm install --build-from-source=realm
 
         - Check [node-gyp](https://github.com/nodejs/node-gyp) manual for custom installation procedure for Windows
 
+## Debugging the node addon
+
+You can use (Visual Studio Code)[https://code.visualstudio.com/] to develop and debug. In the `.vscode` folder, configuration for building and debugging has been added for your convience.
+
+VSCode has good support for debugging JavaScript, but to work with C++ code, you are required to install two additional VSCode extensions:
+
+* Microsoft C/C++
+* CodeLLDB 
+
+To begin, you will need to build the node addon and prepare the test environment:
+
+```
+npm install --build-from-source --debug
+(cd tests && npm install)
+```
+
+Prior to begin debugging, you must start Realm Object Server. In VSCode, under menu *Tasks*/*Run Task*, find *Download and Start Server*.
+
+In the debugging pane, you can find `Debug LLDB + NodeJS` in the dropdown. First select *Start Debugging* in the *Debug* menu.
+
 ## Issues with debugging
 Some users have reported the Chrome debugging being too slow to use after integrating Realm into their react-native project. This is due to the blocking nature of the RPC calls made through the Realm library. It is an ongoing issue and we are actively working on fixing it. See https://github.com/realm/realm-js/issues/491 for more information.