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

moving the README to markdown #14

Merged
merged 1 commit into from Jan 2, 2016

Conversation

Projects
None yet
2 participants
@garu
Contributor

garu commented Dec 29, 2015

Hello!

First of all, thank you for the time and effort you put on DBM::Deep. I really appreciate it!

This is a small patch that formats the README file in markdown, making it much easier on the eyes both in the terminal (since it's still just formatted text) and on the project's github page, with bullet points, headers, links, and even highlighted code samples.

While doing so, I also took the liberty to replace a lot of the duplicated text with more concise and maintainable information, filled with links pointing the user to the actual docs in DBM::Deep's PODs. It feels much better to me, I hope it does to you too! :)

Thanks again!

@robkinyon

This comment has been minimized.

Show comment
Hide comment
@robkinyon

robkinyon Dec 30, 2015

Owner

A few things:

  1. You need to add yourself to the contributors.
  2. Are there other documentation fixes you feel should be done?
  3. How will this play with CPAN and other parts of the Perl toolchain?

I use Markdown for other projects, particularly in Ruby, but this would be the first time I'd be using it for a Perl project.

Owner

robkinyon commented Dec 30, 2015

A few things:

  1. You need to add yourself to the contributors.
  2. Are there other documentation fixes you feel should be done?
  3. How will this play with CPAN and other parts of the Perl toolchain?

I use Markdown for other projects, particularly in Ruby, but this would be the first time I'd be using it for a Perl project.

@garu

This comment has been minimized.

Show comment
Hide comment
@garu

garu Dec 31, 2015

Contributor

Thanks @robkinyon!

  1. Done! #16 :)
  2. I'm okay with how it is now. If I ever bump into something again, I'll make another PR and let you know :)
  3. CPAN & the toolchain are very Markdown friendly! You can safely swap the "README" with a "README.md" on any Perl dist and they will all DTRT \o/

Thanks again!

Contributor

garu commented Dec 31, 2015

Thanks @robkinyon!

  1. Done! #16 :)
  2. I'm okay with how it is now. If I ever bump into something again, I'll make another PR and let you know :)
  3. CPAN & the toolchain are very Markdown friendly! You can safely swap the "README" with a "README.md" on any Perl dist and they will all DTRT \o/

Thanks again!

robkinyon added a commit that referenced this pull request Jan 2, 2016

Merge pull request #14 from garu/garu/markdown
moving the README to markdown

@robkinyon robkinyon merged commit a1bbab4 into robkinyon:master Jan 2, 2016

@garu garu deleted the garu:garu/markdown branch Jan 4, 2016

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