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

include README file in bluefin.cabal #38

Open
juhp opened this issue Jan 27, 2025 · 3 comments
Open

include README file in bluefin.cabal #38

juhp opened this issue Jan 27, 2025 · 3 comments

Comments

@juhp
Copy link

juhp commented Jan 27, 2025

It would be nice to have the readme file included in the main package I think.

@tomjaguarpaw
Copy link
Owner

This sounds like a good idea. I think your primary goal is to get something useful on the Hackage page of bluefin, right?

There are at least two ways of doing that

  1. The description field of the .cabal file, which becomes included into the top of the package page.

  2. The package README/.md, which becomes included into the bottom.

Do you have a preference about which method bluefin uses?

@juhp
Copy link
Author

juhp commented Feb 1, 2025

Probably README is easier? Though it wouldn't hurt to expand the description a bit too :-)

I guess you could symlink the existing README into bluefin/?

Though either 1 or 2 would be an improvement over the status quo.

@tomjaguarpaw
Copy link
Owner

I guess you could symlink the existing README into bluefin/?

I could, but that README is for the repo really, rather than the package, although in its current form I guess it's suitable for the package.

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

No branches or pull requests

2 participants