search

cdepillabout / password

datatypes and functions for easily working with passwords in Haskell
http://hackage.haskell.org/package/password
55 stars 16 forks source link

updated README.md files and made separate README files for hackage #12

Closed Vlix closed 4 years ago

Vlix commented 4 years ago

@cdepillabout Oops, just noticed after uploading to hackage, that it won't do markdown if the README file doesn't end in .md. Do you have any idea how to have a different README file on github, vs on hackage?

cdepillabout commented 4 years ago

Do you have any idea how to have a different README file on github, vs on hackage?

Ah, no, I'm not sure how to do this.

Is there a reason for wanting both a README.md and a README (without .md)? In my experience, Hackage is pretty good at rendering the README.md.

Vlix commented 4 years ago

Because the README.md had a link to ../password, which does not work on hackage. Hmmm, I wonder if you can have a README.md and a README.MD file at the same time, check which one GitHub prioritizes, and use the other one for hackage?

cdepillabout commented 4 years ago

You could just change the [password](../password) link to something like [password](https://github.com/cdepillabout/password/tree/master/password). I'd be completely fine with that.

Or instead of linking to github, you could just link directly to the password package on Hackage.

I think this would be nicer than trying to keep two different READMEs in sync.

Vlix commented 4 years ago

I opted for linking to hackage directly. The README in the root folder is better to use for GitHub and using the ones in the library folders for hackage makes the most sense IMHO.