Skip to content

Conversation

@at669
Copy link
Contributor

@at669 at669 commented Nov 13, 2020

No description provided.

@at669 at669 marked this pull request as ready for review November 13, 2020 18:18
README.md Outdated
> The contents of this repository are in active development. Its features and API are subject to significant change as development progresses.
## Prerequisites
- A working [ROS environment](https://www.ros.org/install/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we replace this URL with the https://github.com/Unity-Technologies/yantra-dev ? I found the later to be more to the point.

Copy link
Contributor Author

@at669 at669 Nov 13, 2020

Choose a reason for hiding this comment

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

@hyounesy yantra-dev is intended for internal development only afaik!

edit: i did consider linking to this instead--would that be more useful?

Copy link
Contributor

@hyounesy hyounesy Nov 13, 2020

Choose a reason for hiding this comment

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

you are right @at669 . Can't we copy the Readme and modify it a bit to our Unity-Hub tutorial directory (@sarah-gibson)?

Copy link
Contributor Author

@at669 at669 Nov 13, 2020

Choose a reason for hiding this comment

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

@hyounesy i think part of the problem is that we won't be distributing a VM, and many users will be performing these tasks on a dedicated linux machine, and the yantra instructions are pretty VM-specific--however I do think this relates to AIRO-302, which is still tbd though

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, you are right . So, can someone without prior ROS experience be able to set it up just using the https://www.ros.org/install/ instructions, and not using the VM image?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@hyounesy the instructions are Ubuntu/Debian/Windows-centric, so assuming they have access to a VM image or a dedicated machine, I think this will be able to take them through the necessary steps, and any installation-related issues will be better off getting help from the ROS sites. our tutorials are made specifically using Melodic, but I didn't want to link specifically to that given that only the tutorials are made using it, but I believe the packages are version agnostic as long as they are still ROS 1 instead of 2.

Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I have a radical suggestion: I don't think we should include prerequisites on this page at all. It feels like they belong on each individual tutorial page, esp. since each may have different prereqs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sarah-gibson that's a fair point--the URDF importer never technically requires ROS, and unity 2020.2+ is only required for anything using articulation bodies, which isn't always going to be the case for the TCP endpoint. i can take it out!

Copy link
Contributor

Choose a reason for hiding this comment

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

+1. Then I guess this should move to the top of pick-and-play tutorial part 2?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This part assumes you have access to a functional ROS workspace. If you do not yet have a working ROS setup, refer to the Resources section below to get started.
If you're new to ROS, check out the Start Guide on the ROS Wiki to get started.


Resources

  • Setting up a ROS workspace:

Note: this tutorial was made using ROS Melodic.


@hyounesy first of all, didn't realize I said "to get started" twice in a row, but aside from that, this is what it currently says at the top of Part 2 and in the Resources section--do you think it needs to be more specific than this?

README.md Outdated
> The contents of this repository are in active development. Its features and API are subject to significant change as development progresses.
## Prerequisites
- A working [ROS environment](https://www.ros.org/install/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Actually, I have a radical suggestion: I don't think we should include prerequisites on this page at all. It feels like they belong on each individual tutorial page, esp. since each may have different prereqs.

@at669 at669 merged commit 475c1df into main Nov 13, 2020
@at669 at669 deleted the amanda/landing_revamp branch November 13, 2020 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants