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

Proposed README.md file using standardized template #27

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

riverma
Copy link
Collaborator

@riverma riverma commented Jun 30, 2022

Purpose

  • New README.md file format
  • Leveraging https://nasa-ammos.github.io/slim/documentation/starter-kits/#software-project-template
  • ⚠ NOTE: this is a DRAFT pull-request and it needs to be customized / adapted to your repo - please commit to this PR branch with your customizations before merging!
  • ⚠ NOTE: make your modifications by searching for the string INSERT in the file and replacing with appropriate values for your repo
  • ⚠ NOTE: read through the file thoroughly to ensure its well adapted for your repo and your scenario, feel free to modify as needed

Proposed Changes

  • [ADD/CHANGE] README.md file with sample content and format

Testing

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

Successfully merging this pull request may close these issues.

1 participant