-
Notifications
You must be signed in to change notification settings - Fork 691
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
Light reorganisation of the README #10367
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -19,8 +19,22 @@ This Cabal Git repository contains the following main packages: | |||||
The canonical upstream repository is located at | ||||||
https://github.com/haskell/cabal. | ||||||
|
||||||
Ways to get the `cabal-install` binary | ||||||
-------------------------------- | ||||||
## Support window for releases | ||||||
|
||||||
| Latest release | 3.14 | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From looking at the rendered version, the first line is treated as a header, which looks a little weird. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would make more sense if it actually stated the support windows and the difference between them. I'd suggest some text, but I only have a vague idea of our actual support windows aside from the comments in There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Hm, also this raises a fairly big problem with LTS releases in our context: support for newer compilers, which (given the way we handle them) requires major version bumps. Do we need to add an escape hatch somewhere for when someone quite reasonably expects an LTS |
||||||
|---|---| | ||||||
| Long-Term Support release | 3.12 | | ||||||
|
||||||
## Learn how to use `cabal` and get support | ||||||
|
||||||
`cabal` comes with a thorough [User Manual](https://cabal.readthedocs.io). | ||||||
If you are new to `cabal` and want to quickly learn the basics, check | ||||||
[Getting Started With Haskell and Cabal](https://cabal.readthedocs.io/en/latest/getting-started.html). | ||||||
|
||||||
Got questions? Ask in [Haskell Matrix](https://matrix.to/#/#haskell:matrix.org) | ||||||
(online chat) or [Haskell Discourse](https://discourse.haskell.org). | ||||||
|
||||||
## Ways to get the `cabal-install` binary | ||||||
|
||||||
1. _GHCup_ (**preferred**): get GHCup using [the directions on its website](https://www.haskell.org/ghcup/) and run: | ||||||
|
||||||
|
@@ -31,7 +45,7 @@ Ways to get the `cabal-install` binary | |||||
2. _[Download from official website](https://www.haskell.org/cabal/download.html)_: | ||||||
the `cabal-install` binary download for your platform should contain the `cabal` executable. | ||||||
|
||||||
#### Preview Releases | ||||||
### Preview Releases | ||||||
|
||||||
_Getting unreleased versions of `cabal-install`_: gives you a chance to try out yet-unreleased features. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
The colon and italics don't make sense after turning this from a bullet point to a regular paragraph. |
||||||
Currently, we only provide binaries for `x86_64` platforms. | ||||||
|
@@ -66,8 +80,7 @@ Currently, we only provide binaries for `x86_64` platforms. | |||||
from the `Validate` worklow page on GitHub, at the very bottom of the page, | ||||||
or from the `build-alpine` workflow for statically linked Linux builds. | ||||||
|
||||||
Ways to build `cabal-install` for everyday use | ||||||
-------------------------------------------- | ||||||
## Ways to build `cabal-install` for everyday use | ||||||
|
||||||
1. _With cabal-install_: | ||||||
if you have a pre-existing version of `cabal-install`, run: | ||||||
|
@@ -91,17 +104,6 @@ Ways to build `cabal-install` for everyday use | |||||
if you don't have a pre-existing version of `cabal-install`, | ||||||
look into the [`bootstrap`](bootstrap) directory. | ||||||
|
||||||
Learn how to use `cabal` and get support | ||||||
---------------------------------------- | ||||||
|
||||||
`cabal` comes with a thorough [User Manual](https://cabal.readthedocs.io). | ||||||
If you are new to `cabal` and want to quickly learn the basics, check | ||||||
[Getting Started With Haskell and Cabal](https://cabal.readthedocs.io/en/latest/getting-started.html). | ||||||
|
||||||
Got questions? Ask in [Haskell Matrix](https://matrix.to/#/#haskell:matrix.org) | ||||||
(online chat) or [Haskell Discourse](https://discourse.haskell.org). | ||||||
|
||||||
Build for hacking and contributing to cabal | ||||||
------------------------------------------- | ||||||
## Contributing to cabal | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, I like this much more than the previous version! Maybe, backtickize cabal?
Suggested change
|
||||||
|
||||||
Refer to [CONTRIBUTING.md](CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It'd be great to add the GHC support window info somewhere here too. Because that's what I thought about first time I saw this heading.