Add comprehensive documentation and examples

[Copilot]

The repository had minimal documentation (3-line README) with no usage examples or getting-started guide.

Changes

README.md (310 lines)

• Prerequisites: bmnumbers dependency requirement with BondMachine installation link
• Quick Start: 3-step tutorial for immediate usage
• CLI Reference: Complete options documentation with proper formatting
• Expression Format: 4 examples covering scalars, matrices, trigonometric functions, and device-specific code
• Advanced Features: Debug mode, I/O modes (sync/async), neuron statistics, application building, BMAPI maps
• Troubleshooting: Common errors with solutions

examples/ Directory

• 5 expression files: simple_addition, polynomial, trigonometric, matrix_operations, complex_expression
• Configuration template: example_config.json
• Examples README: Usage from both root and examples directory, template for custom expressions

Example Usage

# examples/simple_addition.txt
import sympy as sp
x, y = sp.symbols('x y')
spExpr = x + y
testRanges = None

# From repository root
python flexpy.py -e examples/simple_addition.txt -o output.basm --basm

# With configuration
python flexpy.py -e examples/polynomial.txt -o output.basm --basm --config-file examples/example_config.json -t float64

All examples are runnable and demonstrate core functionality: arithmetic, polynomials, trigonometry, matrices, and complex expressions.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Flexpy documentation</issue_title>
<issue_description>Docs are missing, the readme should be improved with usage and examples. </issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes Flexpy documentation #10

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.