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

Why two readmes? #274

Open
jeffwidman opened this issue Feb 3, 2023 · 0 comments
Open

Why two readmes? #274

jeffwidman opened this issue Feb 3, 2023 · 0 comments

Comments

@jeffwidman
Copy link

jeffwidman commented Feb 3, 2023 •
edited
Loading

I went to open a PR against the readme, but there are two of them...

Is that because you want a pretty one for GitHub and a plaintext one to bundle with the package?

Otherwise why two readmes?

Also, is one the cannonical one that I should update whose contents then gets copied to the other?

Maybe it'd be better to just have the markdown readme and then a CI step in the packaging process that strips the markdown formatting from the readme to generate the plain text version?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jeffwidman