[chore 🧹] Update README with more detailed information #3643
Labels
Comments
|
@daniel-farina do you have any suggestions? |
|
want to submit a PR with the initial improvement, to get the ball rolling? |
|
@niccoloraspa hey, could you share the prompts you used for this? Also, I'm super happy to kick off the PR. The linked doc was written by chatgpt? amaze. |
|
Sure! I just copied the current one as an explanation and just asked if ChatGPT could write a GitHub Readme. The AI gods did the rest |
|
This issue is outdated. We can revisit the improvements we want in a new issue. Closing for now |
github-project-automation
bot
moved this from Todo 🕒
to Done ✅
in Osmosis Chain Development
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Background
The current README does not provide enough information about the project and its goals, as well as clear instructions for getting started and contributing.
It would be useful to update the README with more detailed information and instructions to make it easier for potential users and contributors to understand and engage with the project.
Suggested Design
We can build on top of what ChatGPT proposed https://hackmd.io/@sq7nPjAATDS1_frTus12Wg/H1IQUchws, fixing the mistakes and adding the missing sections (joining mainnet/testnet, links to docs).
Acceptance Criteria
README.mdupdatedThe text was updated successfully, but these errors were encountered: