1
0
mirror of https://github.com/BoostIo/Boostnote synced 2025-12-13 01:36:22 +00:00

Add docs/debug.md

This commit is contained in:
asmsuechan
2017-03-26 23:49:08 -07:00
parent 60e267409c
commit b9457d3e33

20
docs/debug.md Normal file
View File

@@ -0,0 +1,20 @@
# How to debug Boostnote (electron app)
The electron that makes Boostnote is made from Chromium, developers can use `Developer Tools` as same as Google Chrome.
This is how to toggle Developer Tools:
![how_to_toggle_devTools](https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png)
The Developer Tools is like this:
![Developer_Tools](https://cloud.githubusercontent.com/assets/11307908/24343545/eff9f3a6-127b-11e7-94cf-cb67bfda634a.png)
When errors occur, the error messages are displayed at the `console`.
## Debugging
I assume to put `debugger` as a breakpoint into the code is a good way to debug like this:
![debugger](https://cloud.githubusercontent.com/assets/11307908/24343879/9459efea-127d-11e7-9943-f60bf7f66d4a.png)
But this is only an example. You need to find a way to debug which fits with you.
## References
* [Official document of Google Chrome about debugging](https://developer.chrome.com/devtools)