Write README.md file - Githubissues

lfglabs-dev / api.starknet.quest

starknet.quest rust backend

2 stars 17 forks source link

Write README.md file #251

Closed bitfalt closed 1 month ago

bitfalt commented 1 month ago

Adds a README.md file with the followings aspects:

Project Overview
Prerequisites
Installation Instructions
Build Instructions
Running the Project
Troubleshooting

Closes issue #238

bitfalt commented 1 month ago

@Marchand-Nicolas I've started drafting the README.md file, I'm missing: Running the Project and Troubleshooting sections, just waiting for your response to my Telegram questions to write properly the Running the Project section.

Let me know what you think about the rest of the sections. Any feedback is appreciated!

bitfalt commented 1 month ago

@Marchand-Nicolas I've finished the README.md file completely and tested the steps, everything is easy to follow and functions properly. Let me know if you have any feedback or wish to change something!

bitfalt commented 1 month ago

Closing the pull request since there a lot of files changed. Will create a new one due to suggestion of @Marchand-Nicolas