cburstedde / libsc

The "sc" auxiliary library

www.p4est.org/

GNU Lesser General Public License v2.1

35 stars 34 forks source link

Add markdown file extension #186

Open elykwilliams opened 3 months ago

elykwilliams commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

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 commented 3 months ago

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.