From 50dd2ff8233eeffdf724819bc858d3921bfeab4d Mon Sep 17 00:00:00 2001 From: Atul R Date: Thu, 6 Jun 2019 19:18:50 +0200 Subject: [PATCH] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 45a5f4e85..8045dcc8f 100644 --- a/README.md +++ b/README.md @@ -210,7 +210,7 @@ So for nlabel I would run it as: moc nlabel.h -o nlabel_moc.cpp --include ../../core/YogaWidget/yogawidget.h ``` -This will run moc on `headername.h` and generate `headername_moc.cpp`. We will include this file instead of `headername.h`. This is the reason we have `nlabel_moc.cpp`. If you dont do this. Then it will give a symbol not found error. +This will run moc on `headername.h` and generate `headername_moc.cpp`. We will include `headername_moc.cpp` in `config/moc.gypi`. If you dont do this. Then it will give a symbol not found error. I hope QLabel's example is enough for now. For more examples and inspirations we can take a look at other wrapped widgets. @@ -220,6 +220,11 @@ https://medium.com/@atulanand94/debugging-nodejs-c-addons-using-vs-code-27e9940f https://medium.com/cameron-nokes/how-to-debug-native-node-addons-in-mac-osx-66f69f81afcb +# Common errors + +1. Segmentation fault: Segmentation fault occurs when you access a Pointer that is pointing to an invalid memory address. One major reason for this can be that JS garbage collector would have garbage collected the addon generated value and you try accessing it after a while. This is mostly the case if you see seg fault happening randomly after some time of startup. + + ### LICENSE Since we do not in any way modify the code of Qt and only link to it dynamically, I beleive we are in compliance with the LGPL license requirements of QT. And hence this library can be licensed under its own License (for which we have chosen MIT License).