Cleaned and updated README for more recent and in-depth information on origin / goal of project. #6499
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Remingtonewing
changed the title
omichel
requested changes
Feb 14, 2024
| @@ -14,22 +14,38 @@ | |||
|
|
|||
|  | |||
|
|
|||
| Webots provides a complete development environment to model, program and simulate robots, vehicles and mechanical systems. | |||
| Webots provides a complete development environment to model, program and simulate robots, vehicles and mechanical systems. We are an beginner friendly software that is meant to introduce newcomers to the amazing world of fluid robotics. | |||
There was a problem hiding this comment.
Suggested change
| Webots provides a complete development environment to model, program and simulate robots, vehicles and mechanical systems. We are an beginner friendly software that is meant to introduce newcomers to the amazing world of fluid robotics. | |
| 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. |
|
|
||
| [](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-linux) | ||
| [](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-windows) | ||
| [](https://cyberbotics.com/doc/guide/installation-procedure#installation-on-macos) | ||
|
|
||
| ### Tutorials | ||
|
|
||
| For those unfamiliar with Webots or robotic simulations at all, in-depth beginning tutorials can be found at [https://cyberbotics.com/doc/guide/tutorials] |
There was a problem hiding this comment.
Suggested change
| For those unfamiliar with Webots or robotic simulations at all, in-depth beginning tutorials can be found at [https://cyberbotics.com/doc/guide/tutorials] | |
| For those unfamiliar with Webots or robotics simulations at all, in-depth beginning tutorials can be found at [https://cyberbotics.com/doc/guide/tutorials]. |
| ### Tutorials | ||
|
|
||
| For those unfamiliar with Webots or robotic simulations at all, in-depth beginning tutorials can be found at [https://cyberbotics.com/doc/guide/tutorials] | ||
| These tutorials are beginner friendly and has a precise educational objective explained in the first paragraph. We want to make robotic simulations accessible and fun for all. |
There was a problem hiding this comment.
Suggested change
| These tutorials are beginner friendly and has a precise educational objective explained in the first paragraph. We want to make robotic simulations accessible and fun for all. | |
| These tutorials are beginner friendly and have a precise educational objective explained in the first paragraph. They try to make robotics simulations accessible and fun for all. |
|
|
||
| For those unfamiliar with Webots or robotic simulations at all, in-depth beginning tutorials can be found at [https://cyberbotics.com/doc/guide/tutorials] | ||
| These tutorials are beginner friendly and has a precise educational objective explained in the first paragraph. We want to make robotic simulations accessible and fun for all. | ||
| These tutorials are an excellent resource to use for any questions or usage of our software |
There was a problem hiding this comment.
Suggested change
| These tutorials are an excellent resource to use for any questions or usage of our software | |
| These tutorials are an excellent resource to use for any questions or usage of the Webots software. |
| These tutorials are an excellent resource to use for any questions or usage of our software | ||
|
|
||
| ### Bugs | ||
| We host an incredibly wide variety of different software implementations and know of certain bugs that are found within the application. An exhaustive list of bugs can be found here: |
There was a problem hiding this comment.
Suggested change
| We host an incredibly wide variety of different software implementations and know of certain bugs that are found within the application. An exhaustive list of bugs can be found here: | |
| Webots host a large variety of different use cases and we know of certain bugs that are found within the application. An exhaustive list of bugs can be found here: |
Comment on lines
+42
to
+43
| Additionally, this link may be used to address any new bugs found which can then be added to the list to be dealt with accordingly. | ||
| Because of high volumes, many of our bugs also have steps for workarounds listed alongside them on this page. |
There was a problem hiding this comment.
Suggested change
| Additionally, this link may be used to address any new bugs found which can then be added to the list to be dealt with accordingly. | |
| Because of high volumes, many of our bugs also have steps for workarounds listed alongside them on this page. | |
| If you happen to find a new bug, please report it [here](https://github.com/cyberbotics/webots/issues/new/choose) |
| @@ -47,6 +63,11 @@ If you prefer to [compile Webots from source](https://github.com/cyberbotics/web | |||
|
|
|||
| ### 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 and then further developed and commercialized by [Cyberbotics](https://cyberbotics.com) since 1998. Originally it was meant to be used as a research tool to investigate various control algorithms in mobile robotics. 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. We specialize in the development, rendering, and representation of robotic, mechanical, and vehicle systems through our application. Our many different uses include sensor-equiped autonomous vehicles, real-time image segmentation, fluid simulations for marine research, and much much more! | |||
There was a problem hiding this comment.
This is a bit redundant. Here is my suggestion:
Suggested change
| Webots was originally designed at [EPFL](https://epfl.ch) in 1996 and then further developed and commercialized by [Cyberbotics](https://cyberbotics.com) since 1998. Originally it was meant to be used as a research tool to investigate various control algorithms in mobile robotics. 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. We specialize in the development, rendering, and representation of robotic, mechanical, and vehicle systems through our application. Our many different uses include sensor-equiped autonomous vehicles, real-time image segmentation, fluid simulations for marine research, and much much more! | |
| Webots was originally designed at [EPFL](https://epfl.ch) in 1996 and then further developed and commercialized by [Cyberbotics](https://cyberbotics.com) since 1998. Originally, it was meant to be used as a research tool for mobile robotics. 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. |
Comment on lines
+68
to
+71
|  | ||
| [caption](Real Time Sensor Visualization) | ||
|  | ||
| [caption](Fluid Simulation for Marine Robots and Research) |
There was a problem hiding this comment.
These images should be stored on this repo.
|
It's looking like to be easy to finalize this MR. |
I don't know. I am not sure we need these images. Maybe we can re-use some from the user guide as we did for the very first one. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Deleted the line that included "- Participate in the IROS 2023 Simulated Humanoid Robot Wrestling Competition and win 1 Ethereum." - As this event already passed and was no longer relevant.