src/config.c Modified

@@ -16,7 +16,7 @@
 #define is_number(s) (strspn(s, "0123456789.-") == strlen(s))
 #define is_number_perc(s) (strspn(s, "0123456789.-%") == strlen(s))
 #define CONFIG_HOME "$HOME/.config/wimp/"
-#define CONFIG_HOME_XDG "$XDG_CONFIG_HOME/.config/wimp/"
+#define CONFIG_HOME_XDG "$XDG_CONFIG_HOME/wimp/"
 
 
 static const char *DEFAULT_CONFIG =  "\n\

readme.rst Modified

@@ -9,11 +9,40 @@
              ██
 
 
-A desktop with limitless bounds. Picture GIMP but for windows. WIMP, if you will.
+A desktop with limitless bounds. Picture GIMP but for windows. WIMP, if you
+will.
 
-A Wayland compositor based on wlroots.
+A Wayland compositor focussed on organisation and enabling an efficient
+workflow.
 
-This software is a work in progress.
+WIMP is still early in development, but (almost) everything works and is
+usable.
+
+Aims/Features
+-------------
+
+ - Intuitive navigation around and management of many windows
+ - Great trackpad experience
+ - Seamless multi-monitor experience
+ - Remain lightweight and minimal, delegating where appropriate to clients
+ - Wide support of useful desktop wayland protocols
+ - And avoid adding Xwayland
+
+Using WIMP
+----------
+
+WIMP can be called directly from a TTY as `wimp`. I recommend writing a small
+script to set up the session's environment and `exec wimp`.
+
+WIMP looks for a configuration file first at `$XDG_CONFIG_HOME/wimp/config`
+then `$HOME/.config/wimp/config`. An example configuration file is provided and
+also serves as a reference of all possible settings and actions.
+
+Users migrating from X may find `arewewaylandyet.com
+<https://arewewaylandyet.com/>`_ and `this page
+<https://github.com/swaywm/sway/wiki/i3-Migration-Guide>`_ from Sway's wiki
+helpful for finding Wayland-supporting alternatives to common X-specific
+utilies.
 
 Building
 --------
@@ -25,17 +54,19 @@
  - wlroots (currently git master version)
  - cairo
 
-.. code-block:: sh
-
-   make
-   sudo make install
+1. make with `make`
+2. install with `sudo make install`
 
-Acknowledgemnets
+Acknowledgements
 ----------------
 
 I learned a lot (and copied some code) from:
 
- - `wlroots <https://github.com/swaywm/wlroots>`_
  - `sway <https://github.com/swaywm/sway>`_
  - `dwl <https://github.com/djpohly/dwl>`_
  - `labwc <https://github.com/johanmalm/labwc>`_
+
+With special thanks to the guys working on `wlroots
+<https://github.com/swaywm/wlroots>`_, upon which WIMP is built. Their TinyWL
+compositor served as a helpful base to start from.
+