Create a README with examples

[gupichon]

Description:
The repository currently lacks a proper README.md describing how to use pyaml.
We should provide a minimal introduction and several usage examples to help new users understand how to:

• Load a PyAML configuration file
• Access instruments and their devices
• Interact with control system attributes
• Use PyAML in simulation or test environments

Proposed content:
Short project overview and goals
Installation instructions
Code snippets showing basic usage (load, get instrument, get/set attributes)
Link to documentation (when available)

Benefit:
Improves discoverability, onboarding, and usability for new contributors and users.

[JeanLucPons]

I recall that a readthedocs is there for that and is definetally more appropriate than a README.md.
https://pyaml.readthedocs.io/en/latest/?badge=latest

[gupichon]

You're right — the README should stay short, just giving a quick overview, a minimal “Getting started” snippet, and a link to the ReadTheDocs.
Maybe also a link to a simple, well-commented test for reference.

[TeresiaOlsson]

At the moment I think it's sufficient with just something short to help people in the maintainers group to start testing or they won't be able to provide feedback since the majority of them are physicists who in my experience need to run a code to understand it.

Before I think there was a script to run the ESRF example but now it has moved into tests so if you want to try to run yourself and step through the execution to understand the flow of the code you need to extract what you need to do from the tests. Not all maintainers are familiar with pytest so I think as a first step it would be good to add the example script again.