Improve README documentation: fix truncated examples and add build prerequisites

[Ruthwik000]

Issue

The README.md documentation has several issues that make it difficult for new users to build and use the project:

Problems Identified

1. Truncated Example Commands

The Examples section displays incomplete commands:

• Currently shows: ./builddir/examples/sugar_gri
• Should show: ./builddir/examples/sugar_grid_example, ./builddir/examples/sugar_event_controller_example, ./builddir/examples/sugar_file_attributes_example
• This prevents users from actually running the examples

2. Missing Build Prerequisites

No instructions for installing dependencies on different distributions. Users need to know:

• Ubuntu/Debian: sudo apt-get install libgtk-4-dev libglib2.0-dev
• Fedora/RHEL: sudo dnf install gtk4-devel glib2-devel
• Arch: sudo pacman -S gtk4 glib2
• macOS: Brew commands for dependencies

3. No Troubleshooting Section

Common build errors not addressed:

• Missing meson
• GTK4 version incompatibility
• Display server issues
• Build directory conflicts

Proposed Solution

1. Fix the Examples section with complete, working commands
2. Add a Dependencies section with platform-specific installation instructions
3. Add a Troubleshooting section with common build errors and solutions

Impact

These improvements will:

• Reduce user frustration during setup
• Decrease GitHub issues from build failures
• Make the project more welcoming to new contributors

[chimosky]

Please open a PR if you have a fix, I understand and agree with your challenges.

This repo was created not too long ago and hasn't been tested heavily as we've been occupied with other things, the idea is to improve on it which includes the README, so as to provide helpful information.