Improve documentation #199
Conversation
README.md
Outdated
|
|
||
| ```shell | ||
| touch .lldbinit //creates file | ||
| open .lldbinit //opens file |
There was a problem hiding this comment.
If someone doesn't know these commands, they might also not realize that the // comments are not supposed to be written. Generally I prefer not adding comments at the end of command lines, but if you feel strongly then they should at least be commented with # which is the shell syntax for comments.
There was a problem hiding this comment.
Oups my bad there! Yeah makes sense.
There was a problem hiding this comment.
I think the commands are self explanatory so I dropped the comments there. Good point
|
I think I covered all of your points/ mentions @kastiglione. Can you please take a look & tell me what you think? 😃 |
|
Hey @kastiglione, any updates on this Pull Request? Is it ready to be merged? What do you think? Are there any other changes that you may want to suggest? |
|
Thanks for contributing this @agisilaos. Apologies for not being more of a prompt reviewer. |
This PR contains improvements to the current documentation. Before explaining the changes I would like to take a moment & explain why I made the PR.
So initially I had some problems getting started with chisel & installing it I thought I was the only one. But it turned out that other people as well had problems finding
.lldbinitfile, or even create it (A couple of issues created with such problems from users).These changes aim to bring clarity to the docs & help people that are new with such files/ installing projects like that get started in a few minutes. Into a bit more detail:
Added commands so the user can check if
.lldbinitfile exists & if it doesn't exist, to create it.Added the command that needs to be added on the
.lldbinitfile when someone installs chisel with brew & I made such changes because sometimes user will not pay attention to the terminal after installing chisel with brew so now the docs will be improved & the experience of the user when he will install chisel much better.These changes are one part of the overall adjustments/improvements that I'm thinking of doing on the documentation side of things. I would like to thank you for creating such an awesome tool for iOS engineers to work better while debugging.