Add More Detailed Documentation

[falhenaki]

Hi, I would really appreciate if you could add more detailed documentation on how to use/run with possibly real examples of what the tool can do. I have been going over the readme/code attempting to understand how to fully utilize the tool but been failing to do so. I think a stronger "how to use" doc would significantly increase UX.

[4ch12dy]

Thanks for your suggestion. But I dont know how to add more detailed docs infact, so I add the example code to show how to use it. Can you give me a case or command that not clear?

[falhenaki]

Thanks for your prompt response. I'd suggest the following:

• Begin the Readame with an introduction of what the tool does, what cases it can be used, and what benefit it provides.
• In the installation instructions, please specify whether the tool should be installed on the iOS device or a PC/Mac
• Specify why "Tap2debug" is highly recommended, and how it works in conjunction with xia0LLDB.
• After the installation step, explain how the tool can run and how subsequent commands are to be made. insert a smoke-test. This is a short test-case to make sure installation is successful and the tool can do what it's meant to do.
• Lastly, commands, please display both input (with arguments if any) and output in your examples.

[4ch12dy]

Good suggestions! I see. In fact, there are many articles of practice to show issh/xia0LLDB/tap2debug using in my blog. But it is in chinese. I will append your suggestions as prosoble if having time.