Skip to content
This repository was archived by the owner on Oct 5, 2023. It is now read-only.

Proposed README.md file using standardized template #7

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

riverma
Copy link
Contributor

@riverma riverma commented Apr 26, 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

@riverma riverma marked this pull request as ready for review July 8, 2022 00:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant