search

Ptt-official-app / Ptt-iOS

37 stars 7 forks source link

Update the README to include a Quick Start guide for beginners. #92

Closed jhsiao21 closed 6 months ago

jhsiao21 commented 7 months ago

Update the README to include a Quick Start guide for beginners interested in this project.

kkpan11 commented 6 months ago

Hey there! I noticed the PhaseScriptExecutionfailed.png image in this main repository. Have you considered moving it to a different git tracking tree, like a common FAQ section on the Wiki page? I think it might be more appropriate there. What are your thoughts on this? Screen Shot 2024-04-13 at 3 42 30 PM

I understand that this situation may not be permanent and could depend on different operating systems or people's behaviors. Additionally, these kinds of image resources are typically not considered part of the building assets.

Thank you for the improving! :)

jhsiao21 commented 6 months ago

I agree with your advice; it's a better way.

jhsiao21 commented 6 months ago

Hi everyone, I think I lack the necessary permissions, which is why I can't see the Wiki tab on the repo. I have moved the Quick Start instructions into the FAQ.md, which can be added to the wiki page.

This PR now only addresses fixing issue #89.

denkeni commented 6 months ago

We don't have Wiki documentation, and I'm fine with either solution.

I've copied the words to our outside documentation on HackMD here. Hope that helps!