Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

changes made in Readme #66

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

techSaswata
Copy link

Changes Made:
Added Setup and Usage Instructions:

Detailed instructions on how to set up and run the project locally.
Steps to clone the repository and open the project in a web browser.
Instructions for installing dependencies if any are required.
Enhanced "Commands" Section:

Expanded descriptions of available commands, including usage examples.
Added details about acceptable ranges for command values (e.g., flight speed, quality).
Updated the formatting for easier readability.
Included "Features" Section:

Listed current features of the project, such as flying around, procedural world generation, and interactive controls.
Mentioned future planned features, like biomes, airports, and delivery missions.
Expanded Roadmap:

Added detailed explanations of upcoming features and functionalities.
Indicated completed tasks and provided timelines for future updates.
Instructions for Contributing:

Added a section with guidelines on how to contribute to the project.
Provided steps for submitting pull requests, reporting issues, and making suggestions.
Improved Visuals and Formatting:

Added icons and shields for better visual appeal.
Used a consistent structure for all sections.
Improvements Achieved:
Ease of Onboarding: The new setup instructions make it easier for new users and developers to get started with the project quickly.
Clarity: Expanded descriptions in the "Commands" and "Features" sections help users better understand how to interact with the project.
Roadmap Transparency: The enhanced roadmap gives users a clearer picture of the project's direction and encourages contributions.
Better User Experience: The visual enhancements and organized structure make the README more engaging and easier to navigate.
Community Engagement: Contributing guidelines and an invitation for suggestions help to build a more active and collaborative community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant