Skip to content

Commit ff97780

Browse files
committed
Document the package
1 parent 0c0158e commit ff97780

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
[![Build & Test](https://github.com/bcoconni/JSBSim.jl/actions/workflows/build_test.yml/badge.svg)](https://github.com/bcoconni/JSBSim.jl/actions/workflows/build_test.yml)
3+
4+
This package aims to provide a Julia interface to the [JSBSim library](https://github.com/JSBSim-Team/jsbsim).
5+
6+
<p align="center">
7+
<img width="250" heigth="250" src="https://github.com/JSBSim-Team/jsbsim-logo/blob/master/logo_JSBSIM_globe.png">
8+
</p>
9+
10+
JSBSim is a multi-platform, general purpose object-oriented Flight Dynamics Model (FDM) written in C++. The FDM is essentially the physics & math model that defines the movement of an aircraft, rocket, etc., under the forces and moments applied to it using the various control mechanisms and from the forces of nature. JSBSim can be run in a standalone batch mode flight simulator (no graphical displays) for testing and study, or integrated with [FlightGear](https://www.flightgear.org/) or other flight simulator.
11+
12+
## Installation
13+
Just like any registered package, in pkg mode (`]` at the REPL)
14+
```bash
15+
add JSBSim
16+
```
17+
`JSBSim.jl` depends on the [`JSBSim_jll`](https://github.com/JuliaBinaryWrappers/JSBSim_jll.jl) JLL package and on [`CxxWrap`](https://github.com/JuliaInterop/CxxWrap.jl) to provide a Julia interface to the C++ library JSBSim.
18+
19+
## Support
20+
For general support about JSBSim, please [visit the JSBSim project](https://github.com/JSBSim-Team/jsbsim).
21+
22+
For issues specific to `JSBSim.jl`, please open a ticket in this project.

0 commit comments

Comments
 (0)