Skip to content

Commit 16d6e5d

Browse files
CoolSpy3Remingtonewingomichel
authored
Update README to Include More Recent and In-Depth Information (#6721)
* 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]>
1 parent ee602bd commit 16d6e5d

File tree

1 file changed

+30
-7
lines changed

1 file changed

+30
-7
lines changed

README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,29 @@
1313

1414

1515
![Webots Screenshot](docs/guide/images/main_window.png?raw=true "Webots Screenshot")
16+
![Real Time Sensor Visualization](docs/guide/images/sensors/lidar_simulation.png?raw=true)
17+
![Camera Object Recognition](docs/reference/images/camera_recognition.png?raw=true)
18+
19+
Webots provides a complete development environment to model, program, and simulate robots, vehicles, and mechanical systems.
20+
It is a beginner friendly software that is meant to introduce newcomers to the world of robotics.
1621

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

1923
- See the [Webots introduction video](https://www.youtube.com/watch?v=O7U3sX_ubGc).
2024
- View online Webots simulations at [webots.cloud](https://webots.cloud).
21-
- 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.
2225

2326
### Download
2427

2528
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).
2629

27-
Check out installation instructions:
30+
Check out installation instructions and FAQ's:
2831

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

33-
### Build from Source
36+
### Building from Source
3437

35-
If you prefer to [compile Webots from source](https://github.com/cyberbotics/webots/wiki), read the [contributing guidelines](CONTRIBUTING.md).
38+
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).
3639

3740
### Continuous Integration Nightly Tests
3841

@@ -45,8 +48,28 @@ If you prefer to [compile Webots from source](https://github.com/cyberbotics/web
4548
[![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)
4649
[![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)
4750

51+
### Updating Webots
52+
53+
Information about how to update installed versions of Webots can be found [here](https://cyberbotics.com/doc/guide/upgrading-webots).
54+
55+
### Tutorials
56+
57+
For those unfamiliar with Webots or robotics simulations, in-depth tutorials can be found [here](https://cyberbotics.com/doc/guide/tutorials).
58+
These tutorials are beginner friendly and are each focused towards a precise educational objective.
59+
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.
60+
61+
### Bugs
62+
63+
Webots supports a large variety of different use cases, and we cannot address every bug within the application.
64+
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).
65+
An exhaustive list of all known bugs can be found [on GitHub](https://github.com/cyberbotics/webots/issues).
66+
If you find a new bug, please report it [here](https://github.com/cyberbotics/webots/issues/new/choose).
67+
4868
### About us
4969

50-
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.
70+
Webots was originally designed at [EPFL](https://epfl.ch) in 1996 as a research tool for mobile robotics.
71+
In 1998, it began being developed and commercialized by [Cyberbotics](https://cyberbotics.com).
72+
In December 2018, Webots was open sourced.
73+
Since then, [Cyberbotics](https://cyberbotics.com) continues to develop Webots thanks to paid customer support, training, and consulting for industry and academic research projects.
5174

52-
[Contact us](mailto:[email protected]) to discuss your custom robot simulation projects.
75+
[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 commit comments

Comments
 (0)