Skip to content

Commit

Permalink
Update README to Include More Recent and In-Depth Information (#6721)
Browse files Browse the repository at this point in the history
* Update README.md

Added a Tutorials, Bugs, and Updating software section.

Additionally updated the about us section with a more in-depth summary of what the software is meant to do alongside some photograph examples of its usage. 

These photographs and all information were sourced from the website to ensure accuracy.

* address comments from original PR

* update images

* additional cleanup

* fix image captions

* move images to the top

* fix links

* cleanup Bugs and Updating Webots sections

* clarify Bugs section

* add line breaks

* reorder sections

* grammar cleanup

* cleanup Building from Source section

---------

Co-authored-by: Remingtonewing <[email protected]>
Co-authored-by: Olivier Michel <[email protected]>
  • Loading branch information
3 people authored Dec 7, 2024
1 parent ee602bd commit 16d6e5d
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,29 @@


![Webots Screenshot](docs/guide/images/main_window.png?raw=true "Webots Screenshot")
![Real Time Sensor Visualization](docs/guide/images/sensors/lidar_simulation.png?raw=true)
![Camera Object Recognition](docs/reference/images/camera_recognition.png?raw=true)

Webots provides a complete development environment to model, program, and simulate robots, vehicles, and mechanical systems.
It is a beginner friendly software that is meant to introduce newcomers to the world of robotics.

Webots provides a complete development environment to model, program and simulate robots, vehicles and mechanical systems.

- See the [Webots introduction video](https://www.youtube.com/watch?v=O7U3sX_ubGc).
- View online Webots simulations at [webots.cloud](https://webots.cloud).
- Participate in the [IROS 2023 Simulated Humanoid Robot Wrestling Competition](https://webots.cloud/run?version=R2023a&url=https%3A%2F%2Fgithub.com%2Fcyberbotics%2Fwrestling%2Fblob%2Fmain%2Fworlds%2Fwrestling.wbt&type=competition) and win 1 Ethereum.

### Download

Get pre-compiled binaries for the [latest release](https://github.com/cyberbotics/webots/releases/latest), as well as [older releases and nightly builds](https://github.com/cyberbotics/webots/releases).

Check out installation instructions:
Check out installation instructions and FAQ's:

[![Linux](https://img.shields.io/badge/Linux-0f80c0?logo=linux&logoColor=white)](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-linux)
[![Windows](https://img.shields.io/badge/Windows-0f80c0?logo=windows&logoColor=white)](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-windows)
[![macOS](https://img.shields.io/badge/macOS-0f80c0?logo=apple&logoColor=white)](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-macos)

### Build from Source
### Building from Source

If you prefer to [compile Webots from source](https://github.com/cyberbotics/webots/wiki), read the [contributing guidelines](CONTRIBUTING.md).
If you prefer to compile Webots from source, instructions can be found in the [wiki](https://github.com/cyberbotics/webots/wiki) and [contributing guidelines](CONTRIBUTING.md).

### Continuous Integration Nightly Tests

Expand All @@ -45,8 +48,28 @@ If you prefer to [compile Webots from source](https://github.com/cyberbotics/web
[![Windows build (develop)](https://github.com/cyberbotics/webots/actions/workflows/test_suite_windows_develop.yml/badge.svg?event=schedule)](https://github.com/cyberbotics/webots/actions/workflows/test_suite_windows_develop.yml?query=event%3Aschedule)
[![macOS build (develop)](https://github.com/cyberbotics/webots/actions/workflows/test_suite_mac_develop.yml/badge.svg?event=schedule)](https://github.com/cyberbotics/webots/actions/workflows/test_suite_mac_develop.yml?query=event%3Aschedule)

### Updating Webots

Information about how to update installed versions of Webots can be found [here](https://cyberbotics.com/doc/guide/upgrading-webots).

### Tutorials

For those unfamiliar with Webots or robotics simulations, in-depth tutorials can be found [here](https://cyberbotics.com/doc/guide/tutorials).
These tutorials are beginner friendly and are each focused towards a precise educational objective.
They try to make robotics simulations accessible and fun for all and are an excellent resource to use for any questions or usage of Webots.

### Bugs

Webots supports a large variety of different use cases, and we cannot address every bug within the application.
A list of known bugs and workarounds that will not be fixed in the short-term can be found [here](https://cyberbotics.com/doc/guide/known-bugs).
An exhaustive list of all known bugs can be found [on GitHub](https://github.com/cyberbotics/webots/issues).
If you find a new bug, please report it [here](https://github.com/cyberbotics/webots/issues/new/choose).

### About us

Webots was originally designed at [EPFL](https://epfl.ch) in 1996 and then further developed and commercialized by [Cyberbotics](https://cyberbotics.com) since 1998. In December 2018, Webots was open sourced. Since then, [Cyberbotics](https://cyberbotics.com) continues to develop Webots thanks to paid customer support, training, consulting for industry and academic research projects.
Webots was originally designed at [EPFL](https://epfl.ch) in 1996 as a research tool for mobile robotics.
In 1998, it began being developed and commercialized by [Cyberbotics](https://cyberbotics.com).
In December 2018, Webots was open sourced.
Since then, [Cyberbotics](https://cyberbotics.com) continues to develop Webots thanks to paid customer support, training, and consulting for industry and academic research projects.

[Contact us](mailto:[email protected]) to discuss your custom robot simulation projects.
[Contact us](mailto:[email protected]) to discuss your custom robot simulation projects and any additional comments, concerns, or developments you may have for our project!

0 comments on commit 16d6e5d

Please sign in to comment.