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

Improve first-touch demo #37

Open
brohrer opened this issue Sep 6, 2018 · 0 comments
Open

Improve first-touch demo #37

brohrer opened this issue Sep 6, 2018 · 0 comments
Labels
documentation wishlist A would-be-nice enhancement.

Comments

@brohrer
Copy link
Owner

brohrer commented Sep 6, 2018

For a user's first experience with becca the workflow is

pip install becca
python3
>>> import becca_test.test as test
>>> test.suite()

Which runs the test suite.

This could be improved in several ways:

  1. Have a more interesting world run, such as a simulated robot.
  2. Have a demo() method available through the becca package, rather than having to import becca_test
  3. Have more verbose console feedback about what's going on, to give the user a sense of what's happening behind the scenes.
  4. Have any output images saved to an easy-to-reach directory, perhaps the pwd() or pwd()/demo.
  5. Have the world create its own static visualizations to illustrate what is happening.
  6. [Gold medal, over-the-top] Have the world serve its own live animation of what is happening.
@brohrer brohrer added wishlist A would-be-nice enhancement. documentation labels Sep 6, 2018
@brohrer brohrer added this to top priority in applications Sep 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation wishlist A would-be-nice enhancement.
Projects
applications
top priority
Development

No branches or pull requests

1 participant