Skip to content

Commit db5e956

Browse files
authored
Convert GitHub related documents to Markdown (#2051)
and remove FMI_CCLA.adoc
1 parent 46f7928 commit db5e956

File tree

9 files changed

+530
-568
lines changed

9 files changed

+530
-568
lines changed

CONTRIBUTING.adoc

Lines changed: 0 additions & 414 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 384 additions & 0 deletions
Large diffs are not rendered by default.

FMI_CCLA.adoc

Lines changed: 0 additions & 115 deletions
This file was deleted.

README.adoc

Lines changed: 0 additions & 36 deletions
This file was deleted.

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<picture>
2+
<source media="(prefers-color-scheme: dark)" srcset="docs/images/FMI-logo-horizontal-dark.svg">
3+
<source media="(prefers-color-scheme: light)" srcset="docs/images/FMI-logo-horizontal-light.svg">
4+
<img alt="Functional Mock-up Interface" src="docs/images/FMI-logo-horizontal-light.svg">
5+
</picture>
6+
7+
# Functional Mock-up Interface
8+
9+
The Functional Mock-up Interface (FMI) is a free standard that defines an interface to exchange dynamic models using a combination of XML files, binaries and C code.
10+
It's supported by [240+ tools](https://fmi-standard.org/tools/) and maintained as a [Modelica Association Project](https://modelica.org/projects).
11+
12+
Releases and the [latest development version](https://fmi-standard.org/docs/main/) of the specification are available on the [FMI website](https://fmi-standard.org/).
13+
14+
## Repository Structure
15+
16+
- [docs](docs) &mdash; sources of the specification document
17+
- [headers](headers) &mdash; header files of the C-API
18+
- [schema](schema) &mdash; XSD schema for the modelDescription.xml
19+
- [CONTRIBUTING.md](CONTRIBUTING.md) &mdash; info on contributing to the project and building the specification document
20+
- [README.md](README.md) &mdash; this document
21+
22+
## Branches
23+
24+
- `main` &mdash; development of the next release
25+
- `v{2|3}.0.x` &mdash; maintenance of the 2.0 and 3.0 releases
26+
27+
## Layered Standards
28+
29+
The following [layered standards](https://github.com/modelica/fmi-standard/blob/main/docs/2_6_versioning_layered_standards.adoc#versioning-and-layered-standards) are currently under development:
30+
31+
- [XCP](https://github.com/modelica/fmi-ls-xcp) &mdash; information for calibration and measurement
32+
- [Network Communication](https://github.com/modelica/fmi-ls-bus) &mdash; mapping of variables to buses
33+
- [Structure](https://github.com/modelica/fmi-ls-struct) &mdash; semantic grouping of variables
34+
- [REF](https://github.com/modelica/fmi-ls-ref) &mdash; stimuli and reference results
35+
36+
## Copyright and License
37+
38+
Code and documentation copyright &copy; 2008-2011 the MODELISAR consortium and 2012-2025 the Modelica Association Project FMI.
39+
Code released under the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
40+
Docs released under [Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/).

docs/0___preamble.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ The licenses text can be found in the https://raw.githubusercontent.com/modelica
1313

1414
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights.
1515
Modelica Association shall not be held responsible for identifying such patent rights.
16-
All contributors to this specification have signed the https://github.com/modelica/fmi-standard/blob/master/FMI_CCLA.adoc[Corporate Contributor License Agreement of the FMI Project] or the https://github.com/modelica/ModelicaAssociationCLA/releases/download/1.1.1/ModelicaAssociationCLA_1.1.1.pdf[Contributor License Agreement of the Modelica Association].
16+
All contributors to this specification have signed the https://fmi-standard.org/FMI_CCLA_v1.0_2016_06_21.pdf[Corporate Contributor License Agreement of the FMI Project] or the https://github.com/modelica/ModelicaAssociationCLA/releases/download/1.1.1/ModelicaAssociationCLA_1.1.1.pdf[Contributor License Agreement of the Modelica Association].
1717

1818
{empty}

docs/docinfo.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@
9999
});
100100
</script>
101101

102-
<img style="display: block; margin: 2em auto; width: 30em;" src="images/FMI_logo_horizontal.svg" alt="FMI logo">
102+
<img style="display: block; margin: 2em auto; width: 30em;" src="images/FMI-logo-horizontal-light.svg" alt="FMI logo">

0 commit comments

Comments
 (0)