Improve README for clarity, structure, and onboarding #339
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Revamped the README to enhance readability and accessibility for new users and contributors. Key improvements include: - Added badges for Python version, PyPI, tests, and documentation - Introduced structured sections with emojis for quick navigation - Included installation steps with virtual environment setup - Added quick usage example for DQN agent - Linked documentation, tutorials, and technical report - Clarified contribution guidelines and added citation format These changes aim to provide a friendlier and more informative starting point for researchers and developers using Acme.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the README.md to enhance onboarding, readability, and developer experience. The following changes have been made:
✍️ Added badges for Python version, PyPI, tests, and docs
📚 Reorganized content with a clearer Table of Contents
🚀 Improved "Getting Started" and "Installation" instructions
🧪 Added a Quick Example section for running a DQN agent
📖 Linked tutorial notebook, technical report, and documentation
💡 Enhanced "Contributing" and "Citing Acme" sections for clarity
These updates aim to help new contributors quickly understand the project’s scope and setup, while also improving the overall presentation of the repository.