gpt-anywhere icon indicating copy to clipboard operation
gpt-anywhere copied to clipboard

Published 20 hours ago • verified publisher icon JinayJain

Updated readme for new developers

Open RetroSpaceMan123 opened this issue 1 year ago • 4 comments

Hello! For a class project, I was tasked to find an open source project an contribute documentation changes to it. When looking at this project, I noticed that the current readme file is not friendly to new developers, so I've decided to update it to improve the new developer experience. Thanks for reviewing this pull request!

RetroSpaceMan123 avatar Oct 02 '23 03:10 RetroSpaceMan123

Hey @RetroSpaceMan123! Thanks for the contribution, really appreciate the help. This project depends on Tauri, which depends on Rust as well as NPM/Yarn. It'd be better if the installation instructions included the steps from (or a link to) the prerequisites page.

JinayJain avatar Oct 05 '23 01:10 JinayJain

Thanks for letting me know about Tauri. Once I have some free time, I'll add the prerequisites to the README. Once again, thanks for reviewing my pull request!

RetroSpaceMan123 avatar Oct 06 '23 02:10 RetroSpaceMan123

Hello! I added a line in the How to Contribute section for installing Tauri. If there's anything else that needs to be changed, please let me know.

RetroSpaceMan123 avatar Oct 11 '23 04:10 RetroSpaceMan123

Thanks for the edit! Just one more thing from the Tauri docs, the usual development cycle would be to run yarn tauri dev, which should also install the relevant Rust packages. Could you add that after the yarn install step?

JinayJain avatar Oct 14 '23 04:10 JinayJain