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

docs: Improve hello world velocity for beginners #380

Closed
adamdecaf opened this issue Nov 19, 2018 · 5 comments
Closed

docs: Improve hello world velocity for beginners #380

adamdecaf opened this issue Nov 19, 2018 · 5 comments

Comments

@adamdecaf
Copy link
Member

What were you trying to do?

As a developer without ACH experience I need to integrate Moov's software into my business needs. The faster I'm able to iterate, develop code and ship the happier I am. Ideally the software is consistent and intuitive.

@adamdecaf
Copy link
Member Author

adamdecaf commented Nov 19, 2018

Looking at the following popular projects README's: hugo | caddy | etcd | terraform | mattermost (FOSS chat app).

Roughy, the order of each README follows:

  1. Logo
  2. Links to community, documentation, build status, etc
  3. Short, concise, and compelling feature list
    • Some contain examples
  4. Install / Download / Build
  5. Contributing
    • Issues, Code / PR, testing, feature requests

@adamdecaf
Copy link
Member Author

@wadearnold Do you have suggestions for further improvements? #379 improves the README quite a lot. We'll expand as people give us feedback, but I'm not sure how much more detail to include.

@bkmoovio bkmoovio added bug and removed bug labels Nov 26, 2018
@bkmoovio
Copy link
Contributor

What still needs to be done on this?

@adamdecaf
Copy link
Member Author

I'm not really sure. It'd be nice to have some newbies take a look and tell us what's confusing or missing.

@bkmoovio
Copy link
Contributor

Users have created and sent test cases prior to these updates. Should we close?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants