Enhance README for Godot Virtual Joystick, New Original Logos and previews - Githubissues

MarcoFazioRandom / Virtual-Joystick-Godot

A simple virtual joystick for touchscreens, for both 2D and 3D games, with useful options.

MIT License

743 stars 81 forks source link

Enhance README for Godot Virtual Joystick, New Original Logos and previews #78

Closed Miisan-png closed 3 months ago

Miisan-png commented 3 months ago

This pull request improves the README also added custom new logos. ( i was bored and had extra time so I thought I should do some good contribution :))

Changes Made

Visual Enhancements

Added a new CoverPreview.svg at the start of the README for a more visually appealing introduction
Created and added new SVG logos for a more professional look
Improved the layout of preview images
Added badges for Godot version and GitHub repository

Content Improvements

Restructured the entire README for better readability and flow
Added a concise features list to highlight the joystick's capabilities
Improved the quick start guide with a clearer code example
Created a table for options to make them easier to understand at a glance
Enhanced the FAQ section with better formatting and clearer explanations
Added new sections for contributing and license information

Removals

Removed outdated or redundant information
Eliminated less relevant examples to focus on key functionality
Removed old examples/logos that were no longer relevant

Additions

New SVG logos and graphical elements
More comprehensive setup instructions
Clearer explanation of joystick modes and options

Testing

Verified all links are working correctly
Ensured all images and SVGs render properly on GitHub
Checked formatting in both light and dark modes on GitHub

MarcoFazioRandom commented 3 months ago

Wow! Thank you for this contribution!