Commit b568e158 authored by Pierre Haessig's avatar Pierre Haessig

Better Readme

parent 888d1626
# Example Modelica Project
# CarProjet, an example Modelica project
This project is a minimal simulation of car on a road.
It is intended as a generic example for all Modelica Modeling projects
The CarProject is a minimal simulation of car on a road, with a speed control.
## Checklist
The code is organized in the `CarProject` package which contains:
* the simulation model `CarTest`
* the main components of the simulation : `Car`, `Road` and `Air`
* a subpackage `Components` for the subcomponents of the car: `Engine` and `Controller`
* a subpackage `Interfaces` for Connectors and partial classes,
for illustration purpose only since it is empty.
Author: Pierre Haessig
## Design principles
It is intended as a generic example for all Modelica Modeling projects.
Here are some principles I targeted during the development.
* The package structure is reasonably "tidy"
* All models have a description string
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment