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

Please add demo instructions to README #17

Open
maltfield opened this issue Sep 2, 2020 · 0 comments
Open

Please add demo instructions to README #17

maltfield opened this issue Sep 2, 2020 · 0 comments

Comments

@maltfield
Copy link

maltfield commented Sep 2, 2020

Please add some instructions for the user to try out this module.

This repo has screenshots of the example, but the README makes no hint as to how that demo can be accessed. After some time, I had to dig through the code to figure out that it was main function of the __init_.py file.

Please add a "Demo" section to the main README.md file of this repo that says something to the effect of:

You can test the functionality of garden.navigationdrawer by executing the demo as follows:

git clone https://github.com/kivy-garden/garden.navigationdrawer.git
python3 garden.navigationdrawer/__init__.py

This should open the following interactive demo:
(put the screenshot image here)

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

No branches or pull requests

1 participant