From 5996cca0be250cca03629b83a9e45901c083321f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A9cate?= Date: Tue, 14 May 2024 20:16:11 +0200 Subject: [PATCH] Update README.md --- README.md | 35 +++++------------------------------ 1 file changed, 5 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 530e752d52..ece3374dbf 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,9 @@ -# Haddock [![CI][CI badge]][CI page] [![Hackage][Hackage badge]][Hackage page] +# Haddock -Haddock is the standard tool for generating documentation from Haskell code. -Full documentation about Haddock itself can be found in the `doc/` subdirectory, -in [reStructuredText][reST] format. +This repository used to host the Haskell documentation generation tool Haddock, which know lives at: https://gitlab.haskell.org/ghc/ghc/-/tree/master/utils/haddock. -## Project overview +Issues and PRs will be transfered to the Haskell gitlab. Please refrain from opening new tickets and PRs here. -This project consists of three packages: +Ask questions and chat with us at https://matrix.to/#/#haddock:matrix.org. - * `haddock`: provides the `haddock` executable. It is implemented as a tiny - wrapper around `haddock-api`'s `Documentation.Haddock.haddock` function. - - * `haddock-api`: contains the program logic of the `haddock` tool. - [The haddocks for the `Documentation.Haddock` module][Documentation.Haddock] - offer a good overview of the functionality. - - * `haddock-library`: is concerned with the parsing and processing of the - Haddock markup language. Unlike the other packages, it is expected to build - on a fairly wide range of GHC versions. - -## Contributing - -See [CONTRIBUTING.md](CONTRIBUTING.md) to see how to make contributions to the -project. - - -[CI page]: https://github.com/haskell/haddock/actions/workflows/ci.yml -[CI badge]: https://github.com/haskell/haddock/actions/workflows/ci.yml/badge.svg -[Hackage page]: https://hackage.haskell.org/package/haddock -[Hackage badge]: https://img.shields.io/hackage/v/haddock.svg -[reST]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html -[Documentation.Haddock]: http://hackage.haskell.org/package/haddock-api/docs/Documentation-Haddock.html -[cabal v2]: https://cabal.readthedocs.io/en/latest/nix-local-build-overview.html +Thank you for your understanding.