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

Proposal: Adding README to explain examples #47

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

Conversation

GSORF
Copy link

@GSORF GSORF commented Sep 9, 2022

This is a README which shows an overview of (and explains) the available examples.

It is currently Work in Progress, so please give me some time to write up a few instructions for starters. Here is a little TODO list I am trying to complete before asking for approval:

  • Prepare general structure of README (Hardware setup, Tutorial content by listing individual example scripts)
  • Add link to Cannot connect to roscore from android phone #39
  • Add link to Error while registering publisher /rosout: Connection refused #46
  • Add illustration for hardware setup (Smartphone + Flutter, Router, Laptop + ROS - each annotated with IP Address and ROS Master / Hostname / IP)
  • Rename example scripts using scheme 01_XYZ.dart to 08_XYZ.dart in order to ensure structure with some tutorial progression for starters.
  • Add Links to the example scripts
  • Explain all example scripts
  • Find out how to generate "Image" message (and other custom messages) - does a ready-to-use flutter package exist for the 'package:sensor_msgs/msgs.dart' on pub.dev? Maybe kindly ask @TimWhiting if there is some way without custom compilation using a dedicated ROS installation (i.e. we want some easy solution for beginners without the need to install ROS on a linux system)

This is a README which shows and explains the available examples.
@TimWhiting
Copy link
Collaborator

Thanks! 🎉

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.

2 participants