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

Duplicated README files #36

Closed
manuGil opened this issue Jan 25, 2023 · 2 comments · Fixed by #125
Closed

Duplicated README files #36

manuGil opened this issue Jan 25, 2023 · 2 comments · Fixed by #125
Labels
documentation question

Comments

@manuGil
Copy link
Collaborator

manuGil commented Jan 25, 2023

There are two README files in the repository with different information. It would be better to consolidate the information in a single file. Can we move the text from README.rst to README.md?
@Sierd
Copy link
Collaborator

Sierd commented Jan 26, 2023

I remember that these readme files used to serve different purposes. Readme.md is read and displayed by Github. Readme.rst is read and displayed as the project description on the pypi website. Merging them would make sense.

@manuGil
Copy link
Collaborator Author

manuGil commented Jun 23, 2023

Addressed in #125

@manuGil manuGil mentioned this issue Jun 23, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation question
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Implementing TOML file for packaging openearth/aeolis-python
2 participants
@manuGil @Sierd