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 the README.md for habitat client for other collaborators #1

Open
jurra opened this issue Jan 24, 2021 · 3 comments
Open

Comments

@jurra
Copy link
Member

jurra commented Jan 24, 2021

Hi @clive, It would be great to have the README in this format:

Project Title

Simple overview of use/purpose.

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

  • Describe any prerequisites, libraries, OS version, etc., needed before installing program.
  • ex. Windows 10

Installing

  • How/where to download your program
  • Any modifications needed to be made to files/folders

Executing program

  • How to run the program
  • Step-by-step bullets
code blocks for commands

Help

Any advise for common problems or issues.

command to run if program contains helper info

Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History

License

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

@clive
Copy link

clive commented Jan 24, 2021 via email

@narration-sd
Copy link
Member

@clive Apologies - I'm the Clive that Jose was thinking of, as you can see though, named here as @narration-sd .

I got the message since I'm also subscribed, and wish you a pleasant Sunday

@jurra
Copy link
Member Author

jurra commented Jan 24, 2021 via email

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

3 participants