From f242ffa90038ae7fb2d67d7c13add78433a19538 Mon Sep 17 00:00:00 2001 From: Bart Trojanowski Date: Sat, 28 Mar 2009 23:56:24 -0400 Subject: [PATCH] update documentation after switching to github --- README | 179 ++++++++++++++++++++++++++++++++++------------------------------- TODO | 4 +- 2 files changed, 97 insertions(+), 86 deletions(-) diff --git a/README b/README index a2de9da..560411d 100644 --- a/README +++ b/README @@ -1,8 +1,9 @@ -wmiirc-lua copyright (c) 2007 Bart Trojanowski +wmii-lua copyright (c) 2007 Bart Trojanowski website - http://www.jukie.net/~bart/blog/tag/wmiirc-lua irc - #wmiirc-lua on oftc.net - email = http://groups.google.ca/group/wmii-lua + email - http://groups.google.ca/group/wmii-lua + source - http://github.com/bartman/wmii-lua Abstract -------- @@ -10,7 +11,7 @@ wmii [1], window manager improved-improved, is a dynamic window manager for X11. It supports classic and tiled window management with extended keyboard, mouse, and 9P-based [2] remote control. -wmiirc-lua [3] implements an "event loop" script for the wmii window +wmii-lua [3] implements an "event loop" script for the wmii window manager. The goals of the project are to - be fast, small, feature rich, and extensible through plugins, @@ -24,126 +25,132 @@ sucked. I chose lua because it helps me achieve the first and second goals. -Requirements ------------- -The following are required to build wmiirc-lua project: +Requirements for wmii-lua +------------------------- +The following are required to build wmii-lua project: - - wmii, 3.5+ or whatever is in hg at the moment - - libixp, latest - lua5.1 - liblua5.1 - liblua5.1-posix0 - patience (no, it's not a package) -Note that as of version 0.2 wmiirc-lua is tracking wmii project closely, -and we don't officially support anything older then wmii from the hg -(mercurial) repository. +Naturally, wmii-lua depends on wmii. It also depends on libixp, which +is used to communicate with wmii. Both of these projects come from +suskless.org and are tracked upstream using mercurial. You are free +chose how you wish to get libixp and wmii: + - from your distribution + - from wmii-lua's extra packages + - from suckless.org's mercurial repositories -Building prerequisites ----------------------- -If you are running Debian (or derivative) these steps may help you: +Your distribution may have upto date libixp and wmii. Great. + +The easiest way to build libixp and wmii from source is to use the git +submodules of this repository. But that assumes that you have received +this project in a form of a git repository from the above URL. More on +this under "building" below. - 1) install Debian packages that you need to build - apt-get install mercurial git-core \ +Installing prerequisites +------------------------ +If you are running Debian (or derivative) these steps may help you: + + apt-get install git-core \ build-essential debhelper \ libx11-dev libxext-dev libxt-dev \ lua5.1 liblua5.1-0-dev liblua5.1-posix0 \ dwm-tools xclip dstat pkg-config - If you chose to work on plugins, you can install all lua packages - like this: + apt-get build-dep libixp wmii - apt-cache search lua5.1 | awk '/liblua5.1/ { print $1 }' \ - | xargs sudo apt-get install -y +If you chose to work on plugins, you can install all lua packages +like this: - 2) build libixp and wmii from source: + apt-cache search lua5.1 | awk '/liblua5.1/ { print $1 }' \ + | xargs sudo apt-get install -y - hg clone http://suckless.org/hg.rc/libixp - cd libixp - make - sudo make install - cd .. - hg clone http://suckless.org/hg.rc/wmii - cd wmii - make - sudo make install - cd .. +Building & Installation +----------------------- +Now that you have the prerequisites installed, you can choose one of the +following three options. +A. Install in $HOME only -Installation ------------- -Now that you have the prerequisites installed, you can choose one of the -following options. + This method installs wmii-lua in ~/usr and ~/.wmii-lua only. Ther is + no need for super user privileges. - A. Make a Debian package + # (optional) get the sources + git clone git://github.com/bartman/wmii-lua.git + cd wmii-lua - A.1. build the actual DEB + # (optional) configure where things go + make config.mk + vim config.mk - # get the sources, switch to debian branch - git clone git://repo.or.cz/wmiirc-lua.git/ - cd wmiirc-lua - git checkout debian - - make deb + # (optional) build and install libixp and wmii + make ext-update + make ext-install-user - A.2. install deb + # build and install wmii-lua + make install-user - sudo debi +B. Install system wide - A.3. Setting up $HOME for wmiirc-lua + # (optional) get the sources + git clone git://github.com/bartman/wmii-lua.git + cd wmii-lua - # as the user run - install-wmiirc-lua + # (optional) configure where things go + make config.mk + vim config.mk - B. Install system wide, and in $HOME + # (optional) build and install libixp and wmii + make ext-update + make ext + sudo make ext-install - B.1. get the sources + # Build wmii-lua as anyone + make - # (optional) get the sources - git clone git://repo.or.cz/wmiirc-lua.git/ - cd wmiirc-lua - - # (optional) configure where things go - vim config.mk + # Installing software in system directories as root + sudo make install - B.2. Installing software in shared directories + # Setting up $HOME for wmii-lua + install-wmiirc-lua - # build as anyone - make +C. Make a Debian package - # install system-wide as root - make install + # (optional) get the sources + git clone git://github.com/bartman/wmii-lua.git + cd wmii-lua - B.3. Setting up $HOME for wmiirc-lua + # Switch to the debian branch + git checkout debian - # as the user run - install-wmiirc-lua + # Build the .deb + make deb - C. Install in $HOME only + # Install deb + sudo debi - # (optional) get the sources - git clone git://repo.or.cz/wmiirc-lua.git/ - cd wmiirc-lua - - make install-user + # Setting up $HOME for wmii-lua + install-wmiirc-lua Running wmii ------------ -wmiirc-lua is now ready to run, but you still have to make wmii your +wmii-lua is now ready to run, but you still have to make wmii your window manager. You can do this by running the wmii executable from .initrc or .xsession... your choice. cat ~/.xinitrc - wmii + wmii-lua or cat ~/.xsession - exec wmii + exec wmii-lua Note: the base configuration uses Mod4 -- the windows key on PC keyboards -- for some of the binding. If your keyboard, like my @@ -152,19 +159,18 @@ xmodmaprc. See: contrib/remap-caps-ctrl-mod4 Configuration ------------- -All configuration of wmiirc-lua is done by editing the -~/.wmii-3.5/wmiirc file. See doc/configuration for more help on configuring -wmiirc-lua. +All configuration of wmii-lua is done by editing the ~/.wmii-lua/wmiirc +file. See doc/configuration for more help on configuring wmii-lua. -wmiirc-lua supports all the keyboard shortcuts of wmii's shell wmiirc, +wmii-lua supports all the keyboard shortcuts of wmii's shell wmiirc, some of the features of wmii+ruby, as well as some additional ones. See the doc/key-bindings for information on how to control wmii with the -extended key bindings wmiirc-lua provides. +extended key bindings wmii-lua provides. -More advanced users may also write plugins for wmiirc-lua using the +More advanced users may also write plugins for wmii-lua using the plugin API. Plugins live in ~/.wmii-3.5/plugins/ directory, and several come with this package. See the wmii.3lua man page, and doc/plugin-api -for more information about how to write code for wmiirc-lua. +for more information about how to write code for wmii-lua. make man man ./wmii.3lua @@ -172,18 +178,22 @@ for more information about how to write code for wmiirc-lua. Credits ------- -The following people have contributed especially to wmiirc-lua in +The following people have contributed especially to wmii-lua in various ways. They are copyright holders of their respective contributions. - Bart Trojanowski -- Dave O'Neill -- Jean Richard +- Dave O'Neill +- Jean Richard +- David Leadbeater +- Jan-David Quesel +- Stefan Riegler +- Sytse Wielinga Credits ------- -wmiirc-lua is licensed under GPLv2. +wmii-lua is licensed under GPLv2. References ---------- @@ -191,3 +201,4 @@ References [2] http://www.cs.bell-labs.com/sys/man/5/INDEX.html [3] http://www.jukie.net/~bart/blog/wmiirc-in-lua [4] http://www.linuxpowertop.org +# vim:set ft=mkd: diff --git a/TODO b/TODO index 6ea306d..98aa2b5 100644 --- a/TODO +++ b/TODO @@ -1,6 +1,6 @@ If you have any suggests I am happy to add them to the list. -for 0.3 release +for 0.4 release - core - verify required packages in wmii.lua (like lua version number) - version number in the files @@ -56,7 +56,7 @@ future a parameter that wmii.lua passes to it. - improve logging - - use file in ~/.wmii-3.5/ like wmii+ruby + - use file in ~/.wmii-lua/ like wmii+ruby - bundled plugins - 'session_manager' -- 2.11.4.GIT