From: Adam Dickmeiss <adam@indexdata.dk>
Date: Mon, 16 Nov 2015 15:01:50 +0000 (+0100)
Subject: README.md
X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=commitdiff_plain;h=81358822816ed75a14af31a0656550de1329c33a

README.md
---

diff --git a/Makefile.am b/Makefile.am
index a00c190..1f24860 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -16,7 +16,7 @@ pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = yaz.pc
 
 SPEC_FILE=$(PACKAGE).spec
-EXTRA_DIST=$(SPEC_FILE) IDMETA README LICENSE NEWS m4/id-config.sh \
+EXTRA_DIST=$(SPEC_FILE) IDMETA README.md LICENSE NEWS m4/id-config.sh \
 	yaz-config.in yaz.pc.in m4/yaz.m4 m4/yaz_libxml2.m4 buildconf.sh \
 	Doxyfile.in m4/acx_pthread.m4 m4/ac_check_icu.m4
 
diff --git a/README b/README
deleted file mode 100644
index 0fce06f..0000000
--- a/README
+++ /dev/null
@@ -1,46 +0,0 @@
-YAZ toolkit
-
-Copyright (C) 1995-2015 Index Data.
-See the file LICENSE for details.
-
-The primary output of the source here is the YAZ library, which
-contains support functions for implementing the server or client
-role of Z39.50 and SRU.
-
-On Unix, GNU configure is used to configure YAZ and generate Makefiles.
-Type "./configure", then "make" to build YAZ. Read
-doc/installation.unix.html for details.
-
-On Windows, a MS Visual Studio makefile is provided (nmake). The commands
-  cd \win
-  nmake
-should do. Refer to doc/installation.win32.html for details.
-
-Note: If you are using the Git snapshot of YAZ you must have autoconf,
-automake, libtool and xsltproc installed. Before running configure, create
-support files by running buildconf.sh in the top-level directory of YAZ.  
-
-In any case refer to the documentation in sub directory doc or read
-it online at http://www.indexdata.com/yaz/
-
-File organisation:
-
-doc      Documentation.
-
-src      Source for the YAZ library.
-
-util     Utility programs, ASN.1 compiler, MARC dump utility, and others.
-
-client   A demonstration client for testing the protocol. It's bug'n
-         ugly. But, it supports many features.
-
-ztest    A demonstration server that implements a backend.
-
-etc      Various configuration files.
-
-include/yaz The various header files.
-
-To get more information or assistance, send mail to yaz-help@indexdata.dk.
-Even better, sign on to the YAZ mailing list here:
-http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c0df73f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+## YAZ toolkit
+
+Copyright (C) 1995-2015 Index Data.
+See the file LICENSE for details.
+
+The primary output of the source here is the
+[YAZ](http://www.indexdata.com/yaz) library, which contains support
+functions for implementing the server or client role of Z39.50 and SRU.
+
+For more information about YAZ refer to the documentation in sub
+directory `doc` or 
+[online](http://www.indexdata.com/yaz/doc).
+
+To get more information or assistance, send mail to yaz-help@indexdata.dk.
+Even better, sign on to the
+[YAZ mailing list](http://lists.indexdata.dk/cgi-bin/mailman/listinfo/yazlist)
+
diff --git a/debian/rules b/debian/rules
index 3d2eaf2..1ae2907 100755
--- a/debian/rules
+++ b/debian/rules
@@ -24,4 +24,4 @@ override_dh_installchangelogs:
 
 override_dh_installdocs:
 	cp LICENSE debian/copyright
-	dh_installdocs -A README
+	dh_installdocs -A README.md
diff --git a/win/yaz.nsi b/win/yaz.nsi
index bc1bd39..7bfda90 100644
--- a/win/yaz.nsi
+++ b/win/yaz.nsi
@@ -101,7 +101,7 @@ Section "" ; (default section)
 		"$INSTDIR\uninst.exe"
 	SetOutPath $INSTDIR
 	File LICENSE.txt
-	File ..\README
+	File ..\README.md
 	File ..\NEWS
 	SetOutPath $INSTDIR
 	SetOutPath $INSTDIR\ztest
diff --git a/yaz.spec b/yaz.spec
index e654ca5..3ec25e7 100644
--- a/yaz.spec
+++ b/yaz.spec
@@ -122,7 +122,7 @@ rm -fr ${RPM_BUILD_ROOT}
 
 %files
 %defattr(-,root,root)
-%doc README LICENSE NEWS
+%doc README.md LICENSE NEWS
 %{_bindir}/yaz-client
 %{_bindir}/yaz-ztest
 %{_bindir}/zoomsh