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

ReadMe file is vague #21

Open
aravindnatch opened this issue Nov 14, 2018 · 0 comments
Open

ReadMe file is vague #21

aravindnatch opened this issue Nov 14, 2018 · 0 comments
Milestone

Comments

@aravindnatch
Copy link

The readme.me file should be more detailed. For example, instead of just listed that this is an emulation engine for GCP. You should exemplify what GCP stands for. In this case you could state it as "Emulation engine for GCP (Google Cloud Platform".

Another issue that is present in the readme.md file is the lack of detailed instructions on how to set it up. To have a pristine readme file, anyone should be able to reproduce it no matter their skill level. Also, there should be more in depth commands when for the user. Maybe a documentation table should exist on how to perform all the actions.

@dilantha111 dilantha111 added this to the 1.0 milestone Jan 6, 2019
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

2 participants