mirror of
https://github.com/xmonad/xmonad-contrib.git
synced 2025-05-19 11:30:22 -07:00
Reformat README.md, add CHANGES.md, update xmonad-contrib.cabal
This commit is contained in:
Peter Jones
parent
6177841488
commit
4d3f633c73
74
CHANGES.md
Normal file
74
CHANGES.md
Normal file
@ -0,0 +1,74 @@
|
||||
# Change Log / Release Notes
|
||||
|
||||
## 0.12 (?)
|
||||
|
||||
### Miscellaneous Changes
|
||||
|
||||
* `XMonad.Actions.DynamicWorkspaceGroups` now exports `addRawWSGroup`
|
||||
|
||||
* Side tabs were added to the tabbed layout
|
||||
|
||||
* `XMonad/Layout/IndependentScreens` now exports `marshallSort`
|
||||
|
||||
* `XMonad/Hooks/UrgencyHook` now exports `clearUrgency`
|
||||
|
||||
* Exceptions are now caught when finding commands on `PATH` in `Prompt.Shell`
|
||||
|
||||
* Switched to `Data.Default` wherever possible
|
||||
|
||||
* `XMonad.Layout.IndependentScreens` now exports `whenCurrentOn`
|
||||
|
||||
* `XMonad.Util.NamedActions` now exports `addDescrKeys'`
|
||||
|
||||
* EWMH `DEMANDS_ATTENTION` support added to `UrgencyHook`
|
||||
|
||||
* New `useTransientFor` modifier in `XMonad.Layout.TrackFloating`
|
||||
|
||||
* Added the ability to remove arbitrary workspaces
|
||||
|
||||
### New Modules
|
||||
|
||||
* `XMonad.Layout.BinarySpacePartition`
|
||||
|
||||
* `XMonad.Util.WindowState`
|
||||
|
||||
* `XMonad.Util.SpawnNamedPipe`
|
||||
|
||||
* `XMonad.Actions.LinkWorkspaces`
|
||||
|
||||
* `XMonad.Config.Dmwit`
|
||||
|
||||
* `XMonad.Hooks.WorkspaceHistory`
|
||||
|
||||
## 0.9 (October 26, 2009)
|
||||
|
||||
### Updates that Require Changes in `xmonad.hs`
|
||||
|
||||
* `XMonad.Hooks.EwmhDesktops` no longer uses `layoutHook`, the
|
||||
`ewmhDesktopsLayout` modifier has been removed from
|
||||
xmonad-contrib. It uses `logHook`, `handleEventHook`, and
|
||||
`startupHook` instead and provides a convenient function `ewmh` to
|
||||
add EWMH support to a `defaultConfig`.
|
||||
|
||||
* Most `DynamicLog` users can continue with configs unchanged, but
|
||||
users of the quickbar functions `xmobar` or `dzen` will need to
|
||||
change `xmonad.hs`: their types have changed to allow easier
|
||||
composition with other `XConfig` modifiers. The `dynamicLogDzen`
|
||||
and `dynamicLogXmobar` functions have been removed.
|
||||
|
||||
* `WindowGo` or `safeSpawn` users may need to change command lines
|
||||
due to `safeSpawn` changes.
|
||||
|
||||
* People explicitly referencing the "SP" scratchpad workspace should
|
||||
change it to "NSP" which is also used by the new
|
||||
`Util.NamedScratchpad` module.
|
||||
|
||||
* (Optional) People who explicitly use `swapMaster` in key or mouse
|
||||
bindings should change it to `shiftMaster`. It's the current
|
||||
default used where `swapMaster` had been used previously. It works
|
||||
better than `swapMaster` when using floating and tiled windows
|
||||
together on the same workspace.
|
||||
|
||||
## See Also
|
||||
|
||||
<https://wiki.haskell.org/Xmonad/Notable_changes_since_0.8>
|
||||
90
README.md
90
README.md
@ -1,82 +1,40 @@
|
||||
xmonad-contrib : third party extensions to the xmonad window manager
|
||||
# xmonad-contrib: Third Party Extensions to the xmonad Window Manager
|
||||
|
||||
http://xmonad.org
|
||||
You need the ghc compiler and xmonad window manager installed in
|
||||
order to use these extensions.
|
||||
|
||||
You need the ghc compiler and xmonad window manager installed in
|
||||
order to use these extensions.
|
||||
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].
|
||||
|
||||
For installation and configuration instructions, please see the
|
||||
xmonad website, the documents included with the xmonad source
|
||||
distribution, and online haddock documentation:
|
||||
## Getting or Updating XMonadContrib
|
||||
|
||||
http://www.xmonad.org/xmonad-docs
|
||||
* Latest release: <https://hackage.haskell.org/package/xmonad-contrib>
|
||||
|
||||
------------------------------------------------------------------------
|
||||
* Git version: <https://github.com/xmonad/xmonad-contrib>
|
||||
|
||||
Changelogs
|
||||
(To use git xmonad-contrib you must also use the
|
||||
[git version of xmonad] [xmonad-git].)
|
||||
|
||||
For a list of changes since the 0.8.x releases, see:
|
||||
## Contributing
|
||||
|
||||
http://www.haskell.org/haskellwiki/Xmonad/Notable_changes_since_0.8
|
||||
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Updates to XMonadContrib-0.9 that may Require Changes to ~/.xmonad/xmonad.hs
|
||||
|
||||
Please see the Changelogs and xmonad-contrib haddock documentation
|
||||
links for further details regarding the following changes.
|
||||
|
||||
* XMonad.Hooks.EwmhDesktops no longer uses layoutHook, the
|
||||
ewmhDesktopsLayout modifier has been removed from xmonad-contrib. It
|
||||
uses logHook, handleEventHook, and startupHook instead and provides
|
||||
a convenient function 'ewmh' to add EWMH support to a defaultConfig.
|
||||
|
||||
* Most DynamicLog users can continue with configs unchanged, but users
|
||||
of the quickbar functions 'xmobar' or 'dzen' will need to change
|
||||
xmonad.hs: their types have changed to allow easier composition with
|
||||
other XConfig modifiers. The 'dynamicLogDzen' and 'dynamicLogXmobar'
|
||||
functions have been removed.
|
||||
|
||||
* WindowGo or safeSpawn users may need to change command lines due to
|
||||
safeSpawn changes.
|
||||
|
||||
* People explicitly referencing the "SP" scratchpad workspace should
|
||||
change it to "NSP" which is also used by the new Util.NamedScratchpad.
|
||||
|
||||
* (Optional) People who explicitly use swapMaster in key or mouse
|
||||
bindings should change it to shiftMaster. It's the current default
|
||||
used where swapMaster had been used previously. It works better than
|
||||
swapMaster when using floating and tiled windows together on the
|
||||
same workspace.
|
||||
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Getting or updating XMonadContrib
|
||||
|
||||
latest release: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmonad-contrib
|
||||
|
||||
darcs version: darcs get http://code.haskell.org/XMonadContrib
|
||||
|
||||
(To use darcs xmonad-contrib you must also use the darcs version
|
||||
of xmonad.)
|
||||
|
||||
------------------------------------------------------------------------
|
||||
|
||||
Contributing
|
||||
|
||||
Haskell code contributed to this repo should live under the
|
||||
appropriate subdivision of the 'XMonad.' namespace (currently
|
||||
includes Actions, Config, Hooks, Layout, Prompt, and Util). For
|
||||
example, to use the Grid layout, one would import:
|
||||
Haskell code contributed to this repo should live under the
|
||||
appropriate subdivision of the `XMonad` namespace (currently includes
|
||||
`Actions`, `Config`, `Hooks`, `Layout`, `Prompt`, and `Util`). For
|
||||
example, to use the Grid layout, one would import:
|
||||
|
||||
XMonad.Layout.Grid
|
||||
|
||||
For further details, see the documentation for the
|
||||
XMonad.Doc.Developing module and http://xmonad.org website.
|
||||
For further details, see the [documentation] [developing] for the
|
||||
`XMonad.Doc.Developing` module and the [xmonad website] [xmonad].
|
||||
|
||||
------------------------------------------------------------------------
|
||||
## 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://www.xmonad.org/xmonad-docs
|
||||
[developing]: http://xmonad.org/xmonad-docs/xmonad-contrib/XMonad-Doc-Developing.html
|
||||
|
||||
@ -21,7 +21,7 @@ license: BSD3
|
||||
license-file: LICENSE
|
||||
author: Spencer Janssen & others
|
||||
maintainer: xmonad@haskell.org
|
||||
extra-source-files: README.md scripts/generate-configs scripts/run-xmonad.sh
|
||||
extra-source-files: README.md CHANGES.md scripts/generate-configs scripts/run-xmonad.sh
|
||||
scripts/window-properties.sh
|
||||
scripts/xinitrc scripts/xmonad-acpi.c
|
||||
scripts/xmonad-clock.c
|
||||
@ -33,15 +33,16 @@ extra-source-files: README.md scripts/generate-configs scripts/run-xmonad.sh
|
||||
XMonad/Config/dmwit.xmobarrc
|
||||
cabal-version: >= 1.6
|
||||
build-type: Simple
|
||||
bug-reports: http://code.google.com/p/xmonad/issues/list
|
||||
bug-reports: https://github.com/xmonad/xmonad-contrib/issues
|
||||
|
||||
tested-with: GHC==7.10.2
|
||||
GHC==7.8.4,
|
||||
tested-with:
|
||||
GHC==7.6.3,
|
||||
GHC==7.4.2
|
||||
GHC==7.8.4,
|
||||
GHC==7.10.2
|
||||
|
||||
source-repository head
|
||||
type: darcs
|
||||
location: http://code.haskell.org/XMonadContrib
|
||||
type: git
|
||||
location: https://github.com/xmonad/xmonad-contrib
|
||||
|
||||
|
||||
flag use_xft
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user