Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleaned and updated README for more recent and in-depth information on origin / goal of project. #6499

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Remingtonewing
Copy link

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.

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 Remingtonewing requested a review from a team as a code owner February 14, 2024 06:08
@Remingtonewing Remingtonewing changed the title Update README.md Cleaned and updated README for more recent and in-depth information on origin / goal of project. Feb 14, 2024
Copy link
Member

@omichel omichel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution.
See my comments.

@@ -14,22 +14,38 @@

![Webots Screenshot](docs/guide/images/main_window.png?raw=true "Webots Screenshot")

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


[![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)

### 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]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
![image](https://github.com/Remingtonewing/webots/assets/92884659/d1c41397-2945-496d-8c2d-dd717bf59ec2)
[caption](Real Time Sensor Visualization)
![image](https://github.com/Remingtonewing/webots/assets/92884659/7abd2e19-4625-40b8-847f-7a66c182ff93)
[caption](Fluid Simulation for Marine Robots and Research)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These images should be stored on this repo.

@ShuffleWire
Copy link
Contributor

It's looking like to be easy to finalize this MR.
I just need to know which method should I use to upload images, and where ?

@omichel
Copy link
Member

omichel commented Aug 9, 2024

It's looking like to be easy to finalize this MR. I just need to know which method should I use to upload images, and where ?

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
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants