Álvaro González c10d76a486 docs: Update README with Math Formulae Manager project description

- Replace generic sample app description with comprehensive project overview
- Add detailed feature descriptions for formula search, computation, and sharing
- Document unit management and d4rt interpreter integration
- Include rich formula documentation with markdown and images support
- Maintain existing project structure documentation

2025-08-21 15:52:30 +02:00

1.4 KiB

Raw Blame History

Math Formulae Manager

A comprehensive command-line application for managing and computing mathematical formulas across various disciplines including mathematics, physics, medicine, and engineering.

Features

Formula Search and Computation

Search through a vast collection of formulas from multiple domains:
- Mathematics
- Physics
- Medical sciences
- Engineering
- And more!
Input values for formula variables
Get computed results with proper units

Unit Management

Each data value includes its magnitude and unit
Convert between different units seamlessly
Automatic unit validation and conversion

Formula Editor

Built-in formula editor using the d4rt interpreter
Create and modify formulas with ease
Syntax highlighting and validation

Share formulas with other users
Import formulas from the community
Collaborative formula database

Rich Formula Documentation

Each formula includes:

The formula itself - Mathematical expression
Explanation - Detailed description in Markdown format
Images - Visual diagrams, graphs, or illustrations
Examples - Sample calculations and use cases

Project Structure

bin/ - Main executable and entry point
lib/ - Core library code and formula engine
test/ - Unit tests and formula validation tests

Getting Started

[Installation and usage instructions to be added]

Contributing

[Contribution guidelines to be added]

1.4 KiB Raw Blame History