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

Remove 2 of the 3 README files in repo? #51

Closed
mbrukman opened this issue Jan 5, 2022 · 3 comments · Fixed by #53
Closed

Remove 2 of the 3 README files in repo? #51

mbrukman opened this issue Jan 5, 2022 · 3 comments · Fixed by #53
Assignees
@mbrukman
Milestone
Release 0.1.5

Comments

@mbrukman
Copy link
Collaborator

mbrukman commented Jan 5, 2022

This repo currently has 3 README files:

Of these, README.md appears to be the most recently-updated one, and it is the one that is automatically rendered by GitHub upon loading the repo, so maybe it makes sense to remove the other 2 to keep it clean and easier to maintain? Or maybe I'm missing a reason to maintain the README in multiple markup languages?

@rossant — since you mentioned on another issue that you're no longer maintaining this project, I'm happy to help maintain the repo if you'd like to give me access.
@rossant
Copy link
Owner

rossant commented Jan 5, 2022

@rossant — since you mentioned on another issue that you're no longer maintaining this project, I'm happy to help maintain the repo if you'd like to give me access.

Thanks! I'm inviting you.

mbrukman added a commit to mbrukman/ipycache that referenced this issue Jan 9, 2022
@mbrukman
Remove README and README.rst, keeping README.md
7d933a6 
The plain-text README is actually the same content as README.rst, but README.md
is the one that has been maintained more and has strictly more information than
any of the others, and it's the one that's rendered by default on GitHub UI.

README and README.rst are the same (ignoring whitespace diffs via `-b`):

```sh
$ diff -b README README.rst
$
```

Closes rossant#51
@mbrukman mbrukman mentioned this issue Jan 9, 2022
Merged
@mbrukman
Copy link
Collaborator Author

mbrukman commented Jan 9, 2022

@rossant — thanks, accepted your invitation. Would you like to review my PRs (e.g., #53), or do you want me to self-merge them?

@rossant
Copy link
Owner

rossant commented Jan 10, 2022

@rossant — thanks, accepted your invitation. Would you like to review my PRs (e.g., #53), or do you want me to self-merge them?

Please feel free to merge them directly! Thank you!

@mbrukman mbrukman self-assigned this Jan 14, 2022
@mbrukman mbrukman added this to the Release 0.1.5 milestone Jan 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mbrukman mbrukman

Labels
None yet
Projects
None yet
Milestone
Release 0.1.5
Development

Successfully merging a pull request may close this issue.

Remove README and README.rst, keeping README.md mbrukman/ipycache
2 participants
@rossant @mbrukman