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 readme #1

Open
abhi18av opened this issue Jul 13, 2020 · 2 comments
Open

Improve readme #1

abhi18av opened this issue Jul 13, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@abhi18av
Copy link
Member

@emilyncosta , your and @Ankita-1211 suggestions would be great regarding the Readme / usage documentation. Do you find it easy to understand and use?

Your needs would help @sharma-shruti and @abhi18av to think about things like

@abhi18av abhi18av added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 13, 2020
@Ankita-1211
Copy link

The Readme seems fine to me, may be cuz of my previous familiarity with all this.
Video will be more user friendly, but one thing that comes to my mind while setting up , you got to pause & play which sometimes bothers.

Each Step with gif will work best i guess. Can include video link too. Serving everything for varied user. (dont know about feasibility & work it will take to do both :)

What say team @emilyncosta @sharma-shruti ???

@abhi18av
Copy link
Member Author

@Ankita-1211 , yeah me and @sharma-shruti are thinking about it - will probably add the changes by Sunday.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants