Commit Graph

122 Commits

Author SHA1 Message Date
Ramon Roche 9adda29da2 docs(sim): add Try PX4 quick-start and pre-built packages reference (#26957)
Adds documentation for the SITL containers and .deb packages introduced in #26495. The containers are now live on Docker Hub: [`px4io/px4-sitl:latest`](https://hub.docker.com/r/px4io/px4-sitl) and [`px4io/px4-sitl-gazebo:latest`](https://hub.docker.com/r/px4io/px4-sitl-gazebo).

The main addition is a [Try PX4 Simulation](https://docs.px4.io/main/en/dev_setup/try_px4) page that leads with a single `docker run` command and gets someone flying in under a minute. It lives in Getting Started, right after Recommended Hardware/Setup, so it's one of the first things new users see.

The existing `.deb` package reference has been moved from `packaging/px4_sitl_deb.md` to `simulation/px4_sitl.md` and expanded to cover both containers and `.deb` packages on one page. Sections are ordered by how people use them: what's available, install, configure, connect QGC/MAVSDK, connect ROS 2.

Other changes:
- README now has a "Try PX4" section with the docker one-liner above "Build from Source"
- Landing page (`index.md`) reworked to lead with "Try PX4" before "For Developers"
- Toolchain page (`dev_env.md`) gets a tip redirecting simulation-only users to pre-built packages
- `getting_started.md` and `SUMMARY.md` updated with links to the new pages
- Simulation index tip updated to mention containers alongside `.deb` packages

The SIH container image is published as `px4io/px4-sitl` (renamed from `px4io/px4-sitl-sih`) so the default lightweight option carries the simplest name. The Gazebo image remains `px4io/px4-sitl-gazebo`.

Also upgrades all GitHub Actions in the SITL workflow to Node.js 24 compatible versions (`actions/checkout@v6`, `actions/cache@v5`, `actions/upload-artifact@v7`, `actions/download-artifact@v8`, `docker/setup-buildx-action@v4`, `docker/build-push-action@v7`) to fix the Node.js 20 deprecation warning ahead of the June 2026 deadline.

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-04-09 08:51:22 -07:00
Ramon Roche 582a50030c docs(project): add Citation section with BibTeX to README
Adds an explicit Citation section before Governance so researchers can
copy a canonical BibTeX entry without clicking through to Zenodo. Uses
the same author list and concept DOI as CITATION.cff so the citation
always resolves to the latest release. Follows the pattern used by
borglab/gtsam and huggingface/transformers.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-04-07 23:50:30 -06:00
Ramon Roche 2dd5c48a82 docs(project): rearrange README badges and add LFX Insights row
Split badges into two rows: release/DOI/Discord on top, and LF-ecosystem
health signals (OpenSSF Best Practices, LFX Health Score, Contributors,
Active Contributors) below. Removed the noisy "Build all targets" badge
and switched the Discord badge from the pixelated widget PNG to the
shields.io SVG endpoint so it renders crisply on HiDPI displays.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-04-07 23:50:30 -06:00
Ramon Roche f5d9491c6a docs(project): add OpenSSF Best Practices badge to README
Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-03-13 18:17:15 -07:00
Ramon Roche a38b10c9d0 docs: modernize README (#26458)
* docs: modernize README with hero logo, vehicle icons, and fixed links

Add PX4 and Dronecode SVG logos to the repo, replace broken external
Dronecode logo URL, fix SITL badge branch from master to main, and
restructure the README with centered branding, airframe icon row,
quick-start section, and consolidated documentation links.
2026-02-13 08:55:29 +11:00
Ramon Roche e6b80d8800 readme: minor cleanup 2025-02-25 21:16:54 -05:00
Ramon Roche 024dd701fb readme: update maintainers information (#24305)
* creates new maintainers file per oss best practices
* adds Pedro as Space maintainer
2025-02-17 11:11:37 -08:00
Ramon Roche 1b6215fcf3 readme: update ci badge 2024-11-27 17:41:43 -05:00
Federico Ciresola ddc604d0de Broken link to the ARKV6X on the README.md 2024-11-20 12:42:58 -05:00
myxxmikeyxx 6385ecd7dd Update README.md
Fixed Simple typo
2024-10-31 13:31:25 +01:00
Silvan Fuhrer 43509b5cff Update README.md - add Christian as rover maintainer (#23719) 2024-09-24 18:09:30 +02:00
Engin Oksuz 3ad2c641da README.md spelling mistake corrected 2023-10-19 10:01:47 -04:00
Julian Oes 09a0089c80 README: add Cube Orange+ (#21361)
This adds the Cube Orange+ to the list, and also changes the Hex naming
to CubePilot as that is how it is sold/marketed now.

Signed-off-by: Julian Oes <julian@oes.ch>
2023-03-24 05:21:43 +01:00
Junwoo Hwang d6b523b574 Update README: Maintainers, Boards, Roadmap (#21030)
* Update README: Maintainers, Boards, Roadmap

- First step after the community coordination call from January 30th

* README: Fromat list & remove discontinued boards & add others

- Addressed comments

* README: Add Simulation, remove QGC

- Only leave the PX4 specific categories (QGC is not)

* Add Beniamino as ROS2 maintainer

* README: Add note that README is main source of truth for maintainers

- We need to have a source of truth, we can use Github README for that.
2023-02-28 19:06:09 +01:00
Daniel Agar cea185268e msg ROS2 compatibility, microdds_client improvements (timesync, reduced code size, added topics, etc), fastrtps purge
- update all msgs to be directly compatible with ROS2
 - microdds_client improvements
   - timesync
   - reduced code size
   - add to most default builds if we can afford it
   - lots of other little changes
 - purge fastrtps (I tried to save this multiple times, but kept hitting roadblocks)
2022-10-19 19:36:47 -04:00
chris1seto 0ddba3ea90 Fix Discord badge not a link in README (#20406)
* Add link to image
* Update link to nice permalink

Co-authored-by: Chris Seto <chris1seto@gmail.com>
2022-10-13 11:05:28 -07:00
chris1seto 7e9ec325f7 Convert README to Discord (#20400) 2022-10-12 21:41:00 -07:00
Hamish Willee 30e2490d5b Docs are now in user guide and main (#19977)
* Fix links to docs in source to point to docs on main not master

* More docs and scripts that need to point to main
2022-08-01 11:39:39 +10:00
Ramon Roche e5e74f65d7 README: Project governance and trademarks
We need to ensure the Dronecode logo is prominently displayed
and linked to the PX4 brand for trademark protection of PX4 and Dronecode.
If you have any questions about this, please feel free to reach out directly to me.
2022-07-18 11:16:55 -04:00
marcirsch 226b8a6f90 README: Updated links to point to main branch instead of master. Fixed broken links
Signed-off-by: marcirsch <marcell@auterion.com>
2022-07-12 08:38:05 +02:00
Ramon Roche 5918fe6a37 README: update slack invite and badge 2021-07-28 07:39:20 +02:00
Daniel Agar 65745a3676 purge broken qurt support and atlflight boards 2021-07-16 08:53:36 -04:00
DanAbara 64448e17ca Update README.md to fix broken crazyflie2.0 link 2021-07-10 12:03:30 -04:00
Tarik Agcayazi 1520805a20 README: remove redundant autogyro, add High altitude balloons 2021-04-09 08:48:17 +02:00
Lorenz Meier c96ca0434e Update README.md
Sort autopilot generations according to relevance to potential users (latest first)
2021-04-03 12:21:02 +02:00
Lorenz Meier 72ca6902f0 Updated README - general refresh 2021-03-14 14:56:24 +01:00
jinger26 8118886f63 updated roadmap link 2021-01-23 09:32:19 -05:00
Daniel Agar 8e14e13369 README.md update PX4/Firmware -> PX4/PX4-Autopilot 2020-12-15 20:27:03 -05:00
Ricardo Marques fd90387270 README: Cleanup Maintenance Team structure
Changes current Maintenance Team structure in README.md in order to be more organized and with a standard.

Signed-off-by: Ricardo Marques <marques.ricardo17@gmail.com>
2020-11-02 23:31:29 +01:00
Daniel Agar fe84bdac6e README: remove broken jenkins build status badge 2020-07-15 09:54:30 -04:00
Julian Oes 25bfcf0497 README: remove experimental/legacy boards 2020-06-03 10:13:43 -04:00
Julian Oes 08e1532bd0 README: fix 404 link 2020-06-03 10:13:43 -04:00
Hamish Willee 8236b8da81 Fix up doc links to point to master branch 2020-04-21 08:58:40 +02:00
TSC21 73f7243bc8 add links on tokens for the Github Actions pages 2020-03-30 14:59:53 +01:00
TSC21 f52739cc09 add Github Actions build status token to Nuttx targets and SITL Tests 2020-03-30 13:56:42 +01:00
Roman Dvořák 05caa1f2d4 Update README, add autogyro to supported airframes 2020-03-10 08:56:33 +01:00
Daniel Agar 44f9de5e37 delete parrot bebop board support
This target was never fully supported and is heavily dependent on a number of DriverFramework drivers that have no in tree equivalents (bebop bus, flow, rangefinder, etc). Deleting this will make it easier to fully drop DriverFramework shortly.
2020-01-05 19:46:51 -05:00
Matthias Grob 904ab16558 Fix trailing whitespace, EOF newline, indentation 2019-12-09 13:22:19 +01:00
bys1123 d5fb89ee02 Make all boards url link to user guide master branch 2019-11-26 13:19:00 +01:00
斯东Stone 2b9285787e Update Supported Hardware in README.md
1. Move Pixhawk Mini to FMUv3, due to it's using Rev.3 chip, has 2MB flash, and fmuv3 bootloader.
2. Add CUAV V5+ to FMUv5
3. Add CUAV v5 nano
4. Add CUAV Pixhack v3 to FMUv3

Make sure is the hardware URL only on user guide master branch or not
2019-11-26 13:19:00 +01:00
Beat Küng b7a7ba8cfc README: update list of supported boards 2019-11-21 08:19:59 +01:00
Lorenz Meier 748ff7f50a Update README.md
Clarify the naming of FMU versions to not confuse users once the new industrial FMUv5X standard is established.
2019-06-27 08:28:32 +02:00
Daniel Agar d83a35a503 Update README.md
Co-Authored-By: LorenzMeier <lorenz@px4.io>
2019-05-25 20:08:36 +02:00
Daniel Agar 782d2033c0 Update README.md
Fix link for Roman

Co-Authored-By: LorenzMeier <lorenz@px4.io>
2019-05-25 20:08:36 +02:00
Lorenz Meier c3a58c31d3 Update the README to clarify component ownership
This represents more closely the actual maintenance model.
2019-05-25 20:08:36 +02:00
David Sidrane beff3ae66a deprecate gumstix aerocore - no longer supported by mfg 2019-02-12 20:53:45 -05:00
Daniel Agar 71f73adf62 README - remove Coverity badge
Coverity scan has been offline since Monday, January 7, 2019.
2019-01-25 10:14:26 -05:00
Daniel Agar 7996f9723f README add FMUv5 pixhawk 4 and pixhawk 4 mini 2018-11-28 12:23:42 -05:00
TSC21 b11ab09d29 update RTPS/ROS2 Interface POC as Vicente Monge does not work with eProsima anymore 2018-10-08 10:58:45 +02:00
Daniel Agar e3ff623df5 README.md update Jenkins build status icon and url 2018-09-18 20:18:02 -04:00