README, AUR files

Author: jbuchermn

DEV.org

@@ -1,13 +1,15 @@
 #+TITLE: newm developer information
 
-* Current (aiming for v0.1)
+* Current
 ** STRT Install process
 *** STRT Setup standard procedure for VM-based install testing
 - [ ] Proper seatd setup in virtual machine
 - [X] Setup below has virtio not working
 *** STRT AUR package
-- [ ] Include imageio
-** STRT README Idea
+- [X] Include imageio
+- [ ] Fix commit
+- [ ] Test
+** DONE README Idea
 
 * Backlog / Ideas
 ** Titles during OverviewOverlay

README.md

@@ -4,10 +4,41 @@
 
 ## Idea
 
-TODO
+**newm** is a Wayland compositor written with laptops and touchpads in mind. The idea is, instead of placing windows inside the small viewport (that is, the monitor) to arrange them along an arbitrarily large two-dimensional wall (generally without windows overlapping) and focus the compositors job on moving around along this wall efficiently and providing ways to the user to rearrange the wall such that he finds the overall layout intuitive.
+
+So, windows are placed on a two-dimensional grid of tiles taking either one by one, one by two, two by one, ... tiles of that grid. The compositor shows a one by one, two by two, ... view of that grid but scales the windows so they are usable on any zoom level (that is, zooming out the compositor actually changes the windows sizes). This makes switching between a couple of fullscreen applications very easy - place them in adjacent one by one tiles and have the compositor show a one by one view. And so on...
+
+The basic commands therefore are navigation (left, right, top, bottom) and zoom-in and -out. These commands can be handled very intuitively on the touchpad (one- and two-finger gestures are reserved for interacting with the apps):
+- Use three fingers to move around the wall
+- Use four fingers to zoom out (move them upward) or in (downward)
+
+To be able to arange the windows in a useful manner, use
+- Logo (unless configured otherwise) plus one finger on the touchpad to move windows
+- Logo (unless configured otherwise) plus two fingers on the touchpad to change the extent of a window
+
+To get a quick overview of all windows, just hit the Mod (that is, unless configured otherwise, the Logo) key.
+
+These behaviours can (partly) be configured (see below for setup). By default (check [default_config.py](newm/default_config.py)), for example the following key bindings are in place
+- `Logo-hjkl`: Move around
+- `Logo-HJKL`: Move windows around
+- `Logo-Ctrl-hjkl`: Resize windows
+- `Logo-f`: Toggle a fullscreen view of the focused window (possibly resizing it)
+- ...
+
+## Status and limitations
+
+This is the first release of newm. Therefore a lot of configurable behaviour, quality of documentation and the like is still missing. However the basic building blocks have been in use on my machine from the beginning (2018) continuously.
+
+The most relevant functional limitation at the moment is missing support for multi-monitor setups. Apart from that see [pywm](https://github.com/jbuchermn/pywm) for known issues concerning certain applications.
 
 ## Installing
 
+### Arch Linux
+
+For Arch Linux users, a `PKGBUILD` is provided (will be on the AUR). Currently this installation requires the python package `imageio` to be installed via the AUR or vie `pip`.
+
+Alternatively, the installation procedure below is powered by pip.
+
 ### Prerequisites and pywm
 
 [pywm](https://github.com/jbuchermn/pywm) is the abstraction layer for and main dependency of newm. If all prerequisites are installed, the command:
@@ -18,10 +49,9 @@ pip3 install git+https://github.com/jbuchermn/pywm@v0.1
 
 should suffice.
 
-Additionally, unless configured otherwise, newm depends on alacritty.
-
+Additionally, unless configured otherwise, newm depends on alacritty for a default terminal emulator.
 
-### Single-user installation (without newm-login)
+### Single-user installation (without newm-login, preferred)
 
 To install newm:
 
@@ -35,6 +65,8 @@ Start it using
 start-newm
 ```
 
+See also [pywm](https://github.com/jbuchermn/pywm) for troubleshooting.
+
 ### Configuring
 
 #### Setting up the config file
@@ -66,7 +98,7 @@ wallpaper = os.environ['HOME'] + '/wallpaper.jpg'
 
 #### Lock on hibernate
 
-Place in `/lib/systemd/system-sleep/00-lock.sh`
+This can be achieved for example by placing the following in `/lib/systemd/system-sleep/00-lock.sh`
 
 ``` sh
 #!/bin/sh

dist/aur/.SRCINFO

@@ -0,0 +1,42 @@
+pkgbase = newm
+	pkgdesc = Wayland compositor
+	pkgver = 0
+	pkgrel = 1
+	url = https://github.com/jbuchermn/newm
+	arch = any
+	license = MIT
+	makedepends = git
+	makedepends = sed
+	makedepends = python3
+	makedepends = meson
+	makedepends = wayland-protocols
+	makedepends = xorgproto
+	depends = python3
+	depends = wayland
+	depends = libinput
+	depends = libxcb
+	depends = libxkbcommon
+	depends = opengl-driver
+	depends = pixman
+	depends = xcb-util-errors
+	depends = xcb-util-renderutil
+	depends = xcb-util-wm
+	depends = seatd
+	depends = xorg-xwayland
+	depends = python-evdev
+	depends = python-numpy
+	depends = python-imageio
+	depends = python-cairo
+	depends = python-psutil
+	depends = python-websockets
+	depends = python-pam
+	depends = python-pyfiglet
+	depends = python-fuzzywuzzy
+	provides = newm
+	conflicts = newm
+	source = git://github.com/jbuchermn/pywm.git#branch=v0.1
+	source = git://github.com/jbuchermn/newm.git#branch=v0.1
+	md5sums = SKIP
+	md5sums = SKIP
+
+pkgname = newm

PKGBUILD dist/aur/PKGBUILDPKGBUILD renamed to dist/aur/PKGBUILD

@@ -1,11 +1,11 @@
-# PKGBUILD for newm including pywm
+# newm - Wayland compositor
+# Maintainer: Jonas Bucher <j.bucher.mn at gmail>
 
 pkgname=newm
 pkgver=0.1
 pkgrel=1
+license=('MIT')
 pkgdesc="Wayland compositor"
-url="https://github.com/jbuchermn/newm"
-# imageio
 depends=(
     python3
 
@@ -23,6 +23,7 @@ depends=(
 
     python-evdev
     python-numpy
+    python-imageio
 
     python-cairo
     python-psutil
@@ -33,13 +34,14 @@ depends=(
 )
 makedepends=(
     git
+    sed
     python3
     meson
     wayland-protocols
     xorgproto
 )
-license=('MIT')
 arch=('any')
+url="https://github.com/jbuchermn/newm"
 source=(
 	'git://github.com/jbuchermn/pywm.git#branch=v0.1'
 	'git://github.com/jbuchermn/newm.git#branch=v0.1'
@@ -48,6 +50,13 @@ md5sums=(
 	'SKIP'
 	'SKIP'
 )
+provides=('newm')
+conflicts=('newm')
+
+pkgver() {
+    cd $srcdir/newm
+    git describe --long | sed 's/\([^-]*-g\)/r\1/;s/-/./g'
+}
 prepare() {
     cd $srcdir/pywm
     git submodule init