public/Boostnote
1
0
Fork 0
mirror of https://github.com/BoostIo/Boostnote synced 2025-12-13 01:36:22 +00:00
Code Issues Releases Wiki Activity

Changed wording in build.md and debug.md

Browse Source 
I've adjusted the wording in the build and debug files to flow better and make more sense in English.
This commit is contained in:
Salvatore Tosti
2017-04-17 19:38:20 -07:00
parent 901f40a669
commit 85b4eedcd6
2 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/debug.md
View File

@@ -1,20 +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.
# How to debug Boostnote (Electron app)
Boostnote is an Electron app so it's based on Chromium; developers can use `Developer Tools` just like Google Chrome.
This is how to toggle Developer Tools:
You can toggle the `Developer Tools` like this:
![how_to_toggle_devTools](https://cloud.githubusercontent.com/assets/11307908/24343585/162187e2-127c-11e7-9c01-23578db03ecf.png)
The Developer Tools is like this:
The `Developer Tools` will look 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
For example, there is a way to put `debugger` as a breakpoint into the code like this:
For example, you can use the `debugger` to set a breakpoint in the code 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.
This is just an illustrative example, you should find a way to debug which fits your style.
## References
* [Official document of Google Chrome about debugging](https://developer.chrome.com/devtools)