From 60ec684853b0c8a6f9f120c8b58c76188653db6a Mon Sep 17 00:00:00 2001
From: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
Date: Sun, 3 Feb 2019 19:16:20 +0000
Subject: [PATCH] readme: Moved to Markdown

---
 Makefile.am |  2 ++
 README      | 35 -----------------------------------
 README.md   | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 autogen.sh  |  2 +-
 4 files changed, 49 insertions(+), 36 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/Makefile.am b/Makefile.am
index b1ecf130..8ff5e31e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -19,6 +19,8 @@
 ACLOCAL_AMFLAGS = -I m4
 SUBDIRS = eek eekboard src tests bindings docs po data examples
 DISTCHECK_CONFIGURE_FLAGS = --enable-gtk-doc --enable-introspection
+AUTOMAKE_OPTIONS = foreign # allow README.md to exist
+
 
 GITIGNOREFILES =				\
 	INSTALL					\
diff --git a/README b/README
deleted file mode 100644
index 659ca4a5..00000000
--- a/README
+++ /dev/null
@@ -1,35 +0,0 @@
-eekboard - an easy to use virtual keyboard toolkit -*- outline -*-
-
-eekboard is a virtual keyboard software package, including a set of
-tools to implement desktop virtual keyboards.
-
-* Building
-
-** Dependencies
-
-REQUIRED: GLib2, GTK, PangoCairo, libxklavier, libcroco
-OPTIONAL: libXtst, at-spi2-core, IBus, Clutter, Clutter-Gtk, Python, Vala, gobject-introspection, libcanberra
-
-** Build from git repo
-
-  $ git clone git://github.com/ueno/eekboard.git
-  $ cd eekboard
-  $ ./autogen.sh --prefix=/usr --enable-gtk-doc
-  $ make
-  $ sudo make install
-
-** Build from tarball
-
-  $ ./configure --prefix=/usr
-  $ make
-  $ sudo make install
-
-* Running
-
-  $ eekboard
-  $ eekboard -f # show/hide automatically based on focus-in/focus-out events
-
-Even though eekboard -f watches a11y events by default, it currently
-works better with IBus.  To use IBus, do:
-
-  $ gsettings set org.fedorahosted.eekboard focus-listener 'ibus'
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..efecb62e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+eekboard - an easy to use virtual keyboard toolkit
+==================================================
+
+eekboard is a virtual keyboard software package, including a set of
+tools to implement desktop virtual keyboards.
+
+Building
+--------
+
+### Dependencies
+
+REQUIRED: GLib2, GTK, PangoCairo, libxklavier, libcroco
+OPTIONAL: libXtst, at-spi2-core, IBus, Clutter, Clutter-Gtk, Python, Vala, gobject-introspection, libcanberra
+
+### Build from git repo
+
+```
+$ git clone git://github.com/ueno/eekboard.git
+$ cd eekboard
+$ ./autogen.sh --prefix=/usr --enable-gtk-doc
+$ make
+$ sudo make install
+```
+
+### Build from tarball
+
+```
+$ ./configure --prefix=/usr
+$ make
+$ sudo make install
+```
+
+Running
+-------
+
+```
+$ eekboard
+$ eekboard -f # show/hide automatically based on focus-in/focus-out events
+```
+
+Even though `eekboard -f` watches a11y events by default, it currently
+works better with IBus.  To use IBus, do:
+
+```
+$ gsettings set org.fedorahosted.eekboard focus-listener 'ibus'
+```
diff --git a/autogen.sh b/autogen.sh
index 057b8de8..3c6d9762 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -7,7 +7,7 @@ test -z "$srcdir" && srcdir=.
 PKG_NAME="eekboard"
 
 (test -f $srcdir/configure.ac \
-  && test -f $srcdir/README ) || {
+  && test -f $srcdir/README.md ) || {
     echo -n "**Error**: Directory "\`$srcdir\'" does not look like the"
     echo " top-level $PKG_NAME directory"
     exit 1