This site is the home of the JSBSim Reference Manual, a website hosted by GitHub Pages, based on Jekyll.
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 or other flight simulator.
If you want to report bugs or request features/new additions, please open a new issue.
If you want to contribute to the documentation, please submit a pull request
For that, you will need to fork this repository and install Jekyll on your computer.
- Install all prerequisites.
- Install the jekyll and bundler gems.
gem install jekyll bundler- Clone the repo
git clone https://github.com/JSBSim-Team/jsbsim-reference-manual.git- In the directory
./jsbsim-reference-manual/docs, install gems from ourGemfileusing Bundler
bundle config set --local path 'vendor/bundle'
bundle installIf you get an error Could not find 'bundler', delete the file Gemfile.lock and retry.
- Build the site and make it available on a local server
bundle exec jekyll serve- Browse to http://localhost:4000
Jekyll will then run a local web server at http://localhost:4000, rebuilding the site any time you make a change (except if you make changes to _config.yml at which point you will have to interrupt (CTRL+C) and restart bundle exec jekyll serve