search

libyal / libfvde

Library and tools to access FileVault Drive Encryption (FVDE) encrypted volumes
GNU Lesser General Public License v3.0
341 stars 34 forks source link

Renaming README to README.md so that GitHub will render as markdown. #13

Closed jonathancross closed 8 years ago

jonathancross commented 8 years ago

Also updating a bit of formatting and some links.

joachimmetz commented 8 years ago

Thanks for the proposed changes but, README should remain plain text, since is it distributed.

jonathancross commented 8 years ago

Would you be open to just adding the .md file extension if no changes were made inside the file? File contents are already compatable with markdown, so it would be much more redable online.

joachimmetz commented 8 years ago

File contents are already compatable with markdown, so it would be much more redable online.

  1. "File contents are already compatable with markdown" please don't mix "markdown as a language" with "markdown as formatter". The file content is plain text, the fact that the markdown formatter is able to recognize URLs is a side effect.
  2. If you mean by "redable", nicer formatted then version of README it can be found here: https://github.com/libyal/libfvde/wiki (as IMO expected part of the project documentation)

Would you be open to just adding the .md file extension if no changes were made inside the file?

No, since adding .md does not make sense for distribution, nor does making a copy in README.md. This is something that the github interface could provide for in a more flexible way. It now is forcing a workflow on a project developer/maintainer that does not make sense for this project.

jonathancross commented 8 years ago

the fact that the markdown formatter is able to recognize URLs is a side effect...

I was referring to bulleted lists and reflowing of paragraph text.

But no problem, I can clearly see you are not interested in this change. :-)

Thanks for maintaining this project!

joachimmetz commented 8 years ago

I can clearly see you are not interested in this change. :-)

As indicated, thanks for the PR, but alas this does not matches the current project workflow.