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

Add markdown file extension #186

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

elykwilliams
Copy link
Contributor

Change file extension of README

Issue:
Currently, the README uses markdown formatting that is not recognized by github.

Proposed changes:
By adding the .md extension to README, github will detect and format the README appropriately.

@cburstedde
Copy link
Owner

Thanks. I'd be leaning towards maintaing a short README file with just the license and telling readers to read README.md for more details. So README.md would in this PR be a straight copy of the previous README.

Then we should make sure to distribute both files with both autoconf and CMake, and verify make distcheck and cpack.

@cburstedde
Copy link
Owner

While you're at it, may I ask to add a few lines to doc/release_notes.txt? We should rename it to doc/sc_release_notes.txt.

@cburstedde
Copy link
Owner

Thanks. I'd be leaning towards maintaing a short README file with just the license and telling readers to read README.md for more details. So README.md would in this PR be a straight copy of the previous README.

The copying is done, this is cool. Adding a stub README would be good to have due to tradition/convention.

Then we should make sure to distribute both files with both autoconf and CMake, and verify make distcheck and cpack.

For automake, adding README.md to the EXTRA_DIST variable would be required.

@cburstedde
Copy link
Owner

So, to do this consistently across both p4est and libsc, it would be nice to keep README for GNU conformance, maybe just as a stub referencing a more extensive README.md. Plus we may take a step back and move some of the README contents into the doxygen pages, shortening README and adding various links. This requires a documentation bump on the web first.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants