mirror of
https://github.com/xmonad/xmonad.git
synced 2025-05-19 08:30:21 -07:00
sp README, CONFIG, STYLE, TODO
This commit is contained in:
parent
533031e3d6
commit
8881e2ac78
4
CONFIG
4
CONFIG
@ -51,9 +51,9 @@ Ok, looks good.
|
|||||||
|
|
||||||
To have xmonad start using your settings, type 'mod-q'. xmonad will
|
To have xmonad start using your settings, type 'mod-q'. xmonad will
|
||||||
then load this new file, and run it. If it is unable to, the defaults
|
then load this new file, and run it. If it is unable to, the defaults
|
||||||
are used.
|
are used.
|
||||||
|
|
||||||
To load succesfully, both 'xmonad' and 'ghc' must be in your $PATH
|
To load successfully, both 'xmonad' and 'ghc' must be in your $PATH
|
||||||
environment variable. If GHC isn't in your path, for some reason, you
|
environment variable. If GHC isn't in your path, for some reason, you
|
||||||
can compile the xmonad.hs file yourself:
|
can compile the xmonad.hs file yourself:
|
||||||
|
|
||||||
|
16
README
16
README
@ -26,16 +26,16 @@ Building:
|
|||||||
|
|
||||||
Building is quite straightforward, and requires a basic Haskell toolchain.
|
Building is quite straightforward, and requires a basic Haskell toolchain.
|
||||||
On many systems xmonad is available as a binary package in your
|
On many systems xmonad is available as a binary package in your
|
||||||
package system (e.g. on debian or gentoo). If at all possible, use this
|
package system (e.g. on Debian or Gentoo). If at all possible, use this
|
||||||
in preference to a source build, as the dependency resolution will be
|
in preference to a source build, as the dependency resolution will be
|
||||||
simpler.
|
simpler.
|
||||||
|
|
||||||
We'll now walk through the complete list of toolchain dependencies.
|
We'll now walk through the complete list of toolchain dependencies.
|
||||||
|
|
||||||
* GHC: the Glasgow Haskell Compiler
|
* GHC: the Glasgow Haskell Compiler
|
||||||
|
|
||||||
You first need a Haskell compiler. Your distribution's package
|
You first need a Haskell compiler. Your distribution's package
|
||||||
system will have binaries of GHC (the Glasgow Haskell Compiler), the
|
system will have binaries of GHC (the Glasgow Haskell Compiler), the
|
||||||
compiler we use, so install that first. If your operating system's
|
compiler we use, so install that first. If your operating system's
|
||||||
package system doesn't provide a binary version of GHC, you can find
|
package system doesn't provide a binary version of GHC, you can find
|
||||||
them here:
|
them here:
|
||||||
@ -46,7 +46,7 @@ Building:
|
|||||||
|
|
||||||
apt-get install ghc6
|
apt-get install ghc6
|
||||||
|
|
||||||
It shouldn't be necessary to compile GHC from source -- every common
|
It shouldn't be necessary to compile GHC from source -- every common
|
||||||
system has a pre-build binary version.
|
system has a pre-build binary version.
|
||||||
|
|
||||||
* X11 libraries:
|
* X11 libraries:
|
||||||
@ -60,7 +60,7 @@ Building:
|
|||||||
Typically you need: libXinerama libXext libX11
|
Typically you need: libXinerama libXext libX11
|
||||||
|
|
||||||
* Cabal
|
* Cabal
|
||||||
|
|
||||||
xmonad requires a recent version of Cabal, >= 1.2.0. If you're using
|
xmonad requires a recent version of Cabal, >= 1.2.0. If you're using
|
||||||
GHC 6.8, then it comes bundled with the right version. If you're
|
GHC 6.8, then it comes bundled with the right version. If you're
|
||||||
using GHC 6.6.x, you'll need to build and install Cabal from hackage
|
using GHC 6.6.x, you'll need to build and install Cabal from hackage
|
||||||
@ -84,7 +84,7 @@ Building:
|
|||||||
unix http://hackage.haskell.org/cgi-bin/hackage-scripts/package/unix
|
unix http://hackage.haskell.org/cgi-bin/hackage-scripts/package/unix
|
||||||
X11 http://hackage.haskell.org/cgi-bin/hackage-scripts/package/X11
|
X11 http://hackage.haskell.org/cgi-bin/hackage-scripts/package/X11
|
||||||
|
|
||||||
* Build xmonad:
|
* Build xmonad:
|
||||||
|
|
||||||
Once you've got all the dependencies in place (which should be
|
Once you've got all the dependencies in place (which should be
|
||||||
straightforward), build xmonad:
|
straightforward), build xmonad:
|
||||||
@ -128,14 +128,14 @@ XMonadContrib
|
|||||||
|
|
||||||
Other useful programs:
|
Other useful programs:
|
||||||
|
|
||||||
A nicer xterm replacment, that supports resizing better:
|
A nicer xterm replacement, that supports resizing better:
|
||||||
|
|
||||||
urxvt http://software.schmorp.de/pkg/rxvt-unicode.html
|
urxvt http://software.schmorp.de/pkg/rxvt-unicode.html
|
||||||
|
|
||||||
For custom status bars:
|
For custom status bars:
|
||||||
|
|
||||||
dzen http://gotmor.googlepages.com/dzen
|
dzen http://gotmor.googlepages.com/dzen
|
||||||
xmobar http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmobar
|
xmobar http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmobar
|
||||||
|
|
||||||
For a program dispatch menu:
|
For a program dispatch menu:
|
||||||
|
|
||||||
|
4
STYLE
4
STYLE
@ -2,7 +2,7 @@
|
|||||||
== Coding guidelines for contributing to
|
== Coding guidelines for contributing to
|
||||||
== xmonad and the xmonad contributed extensions
|
== xmonad and the xmonad contributed extensions
|
||||||
|
|
||||||
* Comment every top level function (particularly exported funtions), and
|
* Comment every top level function (particularly exported functions), and
|
||||||
provide a type signature; use Haddock syntax in the comments.
|
provide a type signature; use Haddock syntax in the comments.
|
||||||
|
|
||||||
* Follow the coding style of the other modules.
|
* Follow the coding style of the other modules.
|
||||||
@ -15,7 +15,7 @@
|
|||||||
* Tabs are illegal. Use 4 spaces for indenting.
|
* Tabs are illegal. Use 4 spaces for indenting.
|
||||||
|
|
||||||
* Any pure function added to the core should have QuickCheck properties
|
* Any pure function added to the core should have QuickCheck properties
|
||||||
precisely defining its behaviour.
|
precisely defining its behavior.
|
||||||
|
|
||||||
* New modules should identify the author, and be submitted under
|
* New modules should identify the author, and be submitted under
|
||||||
the same license as xmonad (BSD3 license or freer).
|
the same license as xmonad (BSD3 license or freer).
|
||||||
|
4
TODO
4
TODO
@ -1,7 +1,7 @@
|
|||||||
- Write down invariants for the window life cycle, especially:
|
- Write down invariants for the window life cycle, especially:
|
||||||
- When are borders set? Prove that the current handling is sufficient.
|
- When are borders set? Prove that the current handling is sufficient.
|
||||||
|
|
||||||
- current floating layer handling is unoptimal. FocusUp should raise,
|
- current floating layer handling is nonoptimal. FocusUp should raise,
|
||||||
for example
|
for example
|
||||||
|
|
||||||
- Issues still with stacking order.
|
- Issues still with stacking order.
|
||||||
@ -15,7 +15,7 @@
|
|||||||
* double check README build instructions
|
* double check README build instructions
|
||||||
* test core with 6.6 and 6.8
|
* test core with 6.6 and 6.8
|
||||||
* bump xmonad.cabal version and X11 version
|
* bump xmonad.cabal version and X11 version
|
||||||
* upload X11 and xmonad to hackage
|
* upload X11 and xmonad to Hackage
|
||||||
* check examples/text in user-facing Config.hs
|
* check examples/text in user-facing Config.hs
|
||||||
* check tour.html and intro.html are up to date, and mention all core bindings
|
* check tour.html and intro.html are up to date, and mention all core bindings
|
||||||
* confirm template config is type correct
|
* confirm template config is type correct
|
||||||
|
Loading…
x
Reference in New Issue
Block a user