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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

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

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bbf5b2
Update README.md
Remingtonewing Feb 14, 2024
30f96d1
Merge branch 'master' into RE-UF-CIS4930
omichel Aug 8, 2024
17aa78e
Merge branch 'master' into RE-UF-CIS4930
omichel Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.



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

### 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].

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.

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.


### 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:

[https://cyberbotics.com/doc/guide/known-bugs]
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.
Comment on lines +42 to +43
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)


### Updating Software

Information about how to update pre-installed versions of Webot can be found at [https://cyberbotics.com/doc/guide/upgrading-webots]

### Build from Source

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


![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)
Comment on lines +68 to +71
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.


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