wimp - readme.rst

-rw-r--r-- readme.rst
      1 .. image:: logo.png
      2    :alt: Logo
      3 
      4 A desktop with limitless bounds. Picture GIMP but for windows. WIMP, if you
      5 will.
      6 
      7 A Wayland compositor focussed on organisation and enabling an efficient
      8 workflow.
      9 
     10 WIMP is still early in development, but (almost) everything works and is
     11 usable.
     12 
     13 Aims/Features
     14 -------------
     15 
     16  - Intuitive navigation around and management of many windows
     17  - Great trackpad experience
     18  - Seamless multi-monitor experience
     19  - Remain lightweight and minimal, delegating where appropriate to clients
     20  - Wide support of useful desktop wayland protocols
     21  - And avoid adding Xwayland
     22 
     23 Using WIMP
     24 ----------
     25 
     26 WIMP can be called directly from a TTY as ``wimp``. I recommend writing a small
     27 script to set up the session's environment and ``exec wimp``.
     28 
     29 WIMP looks for a startup script first at ``$XDG_CONFIG_HOME/wimp/startup`` then
     30 ``$HOME/.config/wimp/startup``. This script is executed once the compositor has
     31 started up and can be used to configure wimp via ``wimptool`` and launch any
     32 startup programs. An example startup script is provided and also serves as a
     33 reference of all possible options and actions.
     34 
     35 Users migrating from X may find `arewewaylandyet.com
     36 <https://arewewaylandyet.com/>`_ and `this page
     37 <https://github.com/swaywm/sway/wiki/i3-Migration-Guide>`_ from Sway's wiki
     38 helpful for finding Wayland-supporting alternatives to common X-specific
     39 utilies.
     40 
     41 Building
     42 --------
     43 
     44 Dependencies:
     45 
     46  - wayland
     47  - wayland-protocols
     48  - wlroots (currently git master version)
     49  - cairo
     50 
     51 1. make with ``make``
     52 2. install with ``sudo make install``
     53 
     54 Acknowledgements
     55 ----------------
     56 
     57 I learned a lot (and copied some code) from:
     58 
     59  - `sway <https://github.com/swaywm/sway>`_
     60  - `dwl <https://github.com/djpohly/dwl>`_
     61  - `labwc <https://github.com/johanmalm/labwc>`_
     62  - `cardboard <https://gitlab.com/cardboardwm/cardboard>`_
     63 
     64 With special thanks to the guys working on `wlroots
     65 <https://github.com/swaywm/wlroots>`_, upon which WIMP is built. Their TinyWL
     66 compositor served as a helpful base to start from.
     67