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.

Sign up for GitHub

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

Jump to bottom

ideas to improve the README #10

Open
rvalyi opened this issue Nov 1, 2020 · 0 comments
Open

ideas to improve the README #10

rvalyi opened this issue Nov 1, 2020 · 0 comments
Labels
enhancement New feature or request

Comments

@rvalyi
Copy link
Member

rvalyi commented Nov 1, 2020

the Docky README can help our enlightened customers, our collaborators, our community. So any improvement is welcome. Here is the default README.md fragement that comes in e brand new Rails 6 project, I think we may copy some ideas.

<<
This README would normally document whatever steps are necessary to get the
application up and running.

Things you may want to cover:

  • Ruby version

  • System dependencies

  • Configuration

  • Database creation

  • Database initialization

  • How to run the test suite

  • Services (job queues, cache servers, search engines, etc.)

  • Deployment instructions

  • ...
    >>
@rvalyi rvalyi added the enhancement New feature or request label Nov 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@rvalyi