readme suitable for distribution

README.md

@@ -1,3 +1,5 @@
+<!-- This file is solely for github front page.
+     For distribution, use doc/README instead. -->
 ![Default options, raw X11](doc/screenshots/alttab-default-rawx.png?raw=true)
 
 ![Low DPI](doc/screenshots/alttab-high.png?raw=true)
@@ -40,6 +42,7 @@ Source
 Copyright 2017 Alexander Kulak <sa-dev AT rainbow POINT by>.
 License: GPLv3 (see COPYING).
 Repository: https://github.com/sagb/alttab
+Chat: #alttab on Freenode
 
 
  -- Alexander Kulak <sa-dev@rainbow.by>  Fri, 28 Apr 2017 13:19:28 +0300

doc/Makefile.am

@@ -1,2 +1,2 @@
 man_MANS = alttab.1
-dist_doc_DATA = xmonad.md ../README.md
+dist_doc_DATA = xmonad.md README

doc/Makefile.in

@@ -149,7 +149,7 @@ NROFF = nroff
 MANS = $(man_MANS)
 DATA = $(dist_doc_DATA)
 am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP)
-am__DIST_COMMON = $(srcdir)/Makefile.in
+am__DIST_COMMON = $(srcdir)/Makefile.in README
 DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
 ACLOCAL = @ACLOCAL@
 AMTAR = @AMTAR@
@@ -251,7 +251,7 @@ xft_LIBS = @xft_LIBS@
 xrender_CFLAGS = @xrender_CFLAGS@
 xrender_LIBS = @xrender_LIBS@
 man_MANS = alttab.1
-dist_doc_DATA = xmonad.md ../README.md
+dist_doc_DATA = xmonad.md README
 all: all-am
 
 .SUFFIXES:

doc/README

@@ -0,0 +1,37 @@
+alttab is X11 window switcher designed for minimalistic window managers
+or standalone X11 session.
+
+  alttab  [-w N] [-mm N] [-bm N] [-mk N] [-kk N] [-t NxM] [-i NxM]
+  [-s N] [-theme name] [-bg color] [-fg color] [-frame color]
+  [-font name] [-v|-vv]
+
+(see man page for details)
+
+Unlike task switchers integrated in most simple window managers (WM) or
+dmenu-like switchers, alttab features visual interface and convenient
+tactile behaviour: press modifier (Alt) - multiple switch with
+a key (Tab) - release modifier.
+Also, it's lightweight and depends only on basic X11 libs, conforming
+to the usage of lightweight WM.
+
+Usage
+-----
+
+Usually it should run fully functional without any argument.
+Start alttab after WM, to let it auto-recognize the WM. For examples, add
+the following to ~/.ratpoisonrc:
+
+  exec alttab
+
+If there are no WM at all, then start alttab in ~/.xsession or elsewhere.
+
+Source
+------
+
+Copyright 2017 Alexander Kulak <sa-dev AT rainbow POINT by>.
+License: GPLv3 (see COPYING).
+Repository: https://github.com/sagb/alttab
+Chat: #alttab on Freenode
+
+
+ -- Alexander Kulak <sa-dev@rainbow.by>  Fri, 28 Apr 2017 13:19:28 +0300