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

Adds more info to readme #2

Merged

Conversation

merschformann
Copy link
Member

Description

Add basic information to the README.md.

Changes

  • Adds basic information to the readme

Copy link

linear bot commented Mar 4, 2024

ENG-4642 Create READMEs for new repos

Create README.md files for the new repositories that welcome the user (particularly when finding the repo not through us).

  • Short intro to what it is about
  • Be explicit/transparent about the non-permissive license
  • Add instructions for how to run it (should be very short and prominent)

@merschformann merschformann merged commit 94d2d68 into develop Mar 4, 2024
4 checks passed
@merschformann merschformann deleted the feature/eng-4642-create-readmes-for-new-repos branch March 4, 2024 15:00
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.

2 participants