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

Create README.md #82

Closed
richardcase opened this issue Sep 9, 2021 · 1 comment · Fixed by #112
Closed

Create README.md #82

richardcase opened this issue Sep 9, 2021 · 1 comment · Fixed by #112
Assignees
@yitsushi
Labels
area/build-and-release Indicates issue or PR related to build or release help wanted Requires help from contributors to get done kind/documentation Documentation only

Comments

@richardcase
Copy link
Member

Describe the solution you'd like:
We currently have a blank readme. We need to change this and provide information about the project and also how to contribute. We need to include badges like the codecov badge

Why do you want this feature:
The project needs to provider information to its users and be a good open source citizen

Anything else you would like to add:
[Miscellaneous information that will assist in solving the issue.]
@richardcase richardcase added kind/feature New feature or request help wanted Requires help from contributors to get done kind/documentation Documentation only and removed kind/feature New feature or request labels Sep 9, 2021
@richardcase richardcase added this to the v0.1.0 milestone Sep 9, 2021
@richardcase
Copy link
Member Author

Hey @yitsushi I’m using ZenHub in GitHub, click this link to join my workspace and see other features available in GitHub or download the ZenHub extension and sign up with your GitHub account.
Posted using ZenHub

@richardcase richardcase added the area/build-and-release Indicates issue or PR related to build or release label Oct 5, 2021
@yitsushi yitsushi self-assigned this Oct 6, 2021
yitsushi added a commit to yitsushi/flintlock that referenced this issue Oct 6, 2021
@yitsushi
Basic structure for README.md and CONTRIBUTING.md
a4915ff 
* Outline README.md
* Basic information in CONTRIBUTING.md

fixes liquidmetal-dev#82
@yitsushi yitsushi mentioned this issue Oct 6, 2021
Merged
2 tasks
yitsushi added a commit to yitsushi/flintlock that referenced this issue Oct 7, 2021
@yitsushi
Basic structure for README.md and CONTRIBUTING.md
9a642e7 
* Outline README.md
* Basic information in CONTRIBUTING.md

fixes liquidmetal-dev#82
yitsushi added a commit to yitsushi/flintlock that referenced this issue Oct 7, 2021
@yitsushi
Basic structure for README.md and CONTRIBUTING.md
9569064 
* Add README.md
* Add CONTRIBUTING.md

fixes liquidmetal-dev#82
yitsushi added a commit to yitsushi/flintlock that referenced this issue Oct 7, 2021
@yitsushi
Basic structure for README.md and CONTRIBUTING.md
1225f95 
* Add README.md
* Add CONTRIBUTING.md

fixes liquidmetal-dev#82
yitsushi added a commit to yitsushi/flintlock that referenced this issue Oct 8, 2021
@yitsushi
Basic structure for README.md and CONTRIBUTING.md
f8840c7 
* Add README.md
* Add CONTRIBUTING.md

fixes liquidmetal-dev#82
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yitsushi yitsushi

Labels
area/build-and-release Indicates issue or PR related to build or release help wanted Requires help from contributors to get done kind/documentation Documentation only
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: basic structure for README.md and CONTRIBUTING.md yitsushi/flintlock
2 participants
@yitsushi @richardcase