From 268fc70d0e71b273ca723e56689dbfcc2c0baf2b Mon Sep 17 00:00:00 2001 From: Tomas Janousek Date: Fri, 22 Oct 2021 16:56:19 +0100 Subject: [PATCH] README: Long overdue update * "community-maintained" is more accurate and sounds better than "third-party" * refresh description * add logo and badges to make it prettier * update doc links --- README.md | 77 +++++++++++++++++++++++++++++++------------- xmonad-contrib.cabal | 8 ++--- 2 files changed, 58 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 6caad9ac..57027bdc 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,56 @@ -# xmonad-contrib: Third Party Extensions to the xmonad Window Manager +

+ XMonad logo +

+

+ + Hackage + + + License + + + Made in Haskell + +
+ + Stack + + + Cabal + + + Nix + +
+ + GitHub Sponsors + + + Open Collective + +

-![Tests](https://github.com/xmonad/xmonad-contrib/workflows/Tests/badge.svg) -[![Open Source Helpers](https://www.codetriage.com/xmonad/xmonad-contrib/badges/users.svg)](https://www.codetriage.com/xmonad/xmonad-contrib) +# xmonad-contrib -You need the ghc compiler and xmonad window manager installed in -order to use these extensions. +**Community-maintained extensions for the [XMonad][web:xmonad] window manager.** -For installation and configuration instructions, please see the -[xmonad website][xmonad], the documents included with the -[xmonad source distribution][xmonad-git], and the -[online haddock documentation][xmonad-docs]. +[xmonad core][gh:xmonad] is minimal, stable, yet extensible. +[xmonad-contrib][gh:xmonad-contrib] is home to hundreds of additional tiling +algorithms and extension modules. The two combined make for a powerful X11 +window-manager with endless customization possibilities. They are, quite +literally, libraries for creating your own window manager. -## Getting or Updating XMonadContrib +[web:xmonad]: https://xmonad.org/ +[gh:xmonad]: https://github.com/xmonad/xmonad +[gh:xmonad-contrib]: https://github.com/xmonad/xmonad-contrib - * Latest release: +## Installation - * Git version: +For installation and configuration instructions, please see: -(To use git xmonad-contrib you must also use the -[git version of xmonad][xmonad-git].) + * [downloading and installing xmonad](https://xmonad.org/download.html) + * [installing latest xmonad snapshot from git](https://xmonad.org/INSTALL.html) + * [configuring xmonad](https://xmonad.org/TUTORIAL.html) ## Contributing @@ -29,15 +61,14 @@ example, to use the Grid layout, one would import: XMonad.Layout.Grid -For further details, see the [documentation][developing] for the -`XMonad.Doc.Developing` module, XMonad's [CONTRIBUTING.md](https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md) and the [xmonad website][xmonad]. +For further details, see the [documentation for the `XMonad.Doc.Developing` +module][doc:developing], XMonad's [CONTRIBUTING][gh:xmonad:contributing] and +the [xmonad website][web:xmonad]. + +[gh:xmonad:contributing]: https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md +[doc:developing]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Doc-Developing.html ## License -Code submitted to the contrib repo is licensed under the same license as -xmonad itself, with copyright held by the authors. - -[xmonad]: http://xmonad.org -[xmonad-git]: https://github.com/xmonad/xmonad -[xmonad-docs]: http://hackage.haskell.org/package/xmonad -[developing]: http://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Doc-Developing.html +Code submitted to the xmonad-contrib repo is licensed under the same license +as xmonad core itself, with copyright held by the authors. diff --git a/xmonad-contrib.cabal b/xmonad-contrib.cabal index 8dbe8273..9fd2a088 100644 --- a/xmonad-contrib.cabal +++ b/xmonad-contrib.cabal @@ -2,11 +2,11 @@ name: xmonad-contrib version: 0.16.999 -- ^ also update cpp-options: -DXMONAD_CONTRIB_VERSION_* -homepage: http://xmonad.org/ -synopsis: Third party extensions for xmonad +homepage: https://xmonad.org/ +synopsis: Community-maintained extensions extensions for xmonad description: - Third party tiling algorithms, configurations and scripts to xmonad, - a tiling window manager for X. + Community-maintained tiling algorithms and extension modules for xmonad, + an X11 tiling window manager. . For an introduction to building, configuring and using xmonad extensions, see "XMonad.Doc". In particular: