From: Paul Brossier <piem@piem.org>
Date: Tue, 14 Mar 2017 02:41:47 +0000 (+0100)
Subject: README.md: improve markdown formatting, update homepage, use https
X-Git-Url: https://git.aubio.org/?a=commitdiff_plain;h=ec5fc10955c2d8e51b93b894d1038ee16f7113c8;p=pd-aubio.git

README.md: improve markdown formatting, update homepage, use https
---

diff --git a/README b/README
deleted file mode 100644
index a1e3873..0000000
--- a/README
+++ /dev/null
@@ -1,40 +0,0 @@
-pd-aubio contains various externals for PureData using the aubio library.
-
-For more information, see:
-  - aubio homepage: http://aubio.org
-  - puredata homepage: http://puredata.info
-
-Building
---------
-
-pd-aubio uses waf. To configure and build it, run:
-
-  $ ./waf configure build
-
-If you have aubio installed in an unusual location, just set your
-PKG_CONFIG_PATH accordingly. For instance, to build against aubio installed in
-/var/tmp/aubio:
-
-  $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
-      distclean configure build install --prefix=/var/tmp/aubio 
-
-Installing
-----------
-
-To install the aubio external for puredata on your system, run the following as
-root:
-
-  # make install
-
-Running
--------
-
-To load the external, start pd as follows
-
-  $ pd -lib aubio
-
-Alternatively, you can create an object [aubio] to initialize the external.
-
-If you want to use the external without installing it, the above command should
-work as expected from the pd-aubio source directory. If needed, set your
-LD_LIBRARY_PATH to include the path to the aubio library.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c3b0308
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+pd-aubio
+========
+
+Various externals for PureData using the aubio library
+
+For more information, see:
+  - aubio homepage: https://aubio.org/pd-aubio
+  - puredata homepage: https://puredata.info
+
+Building
+--------
+
+pd-aubio uses waf. To configure and build it, run:
+
+    $ ./waf configure build
+
+If you have aubio installed in an unusual location, just set your
+`PKG_CONFIG_PATH` accordingly. For instance, to build against aubio installed
+in /var/tmp/aubio:
+
+    $ PKG_CONFIG_PATH=/var/tmp/aubio/lib/pkgconfig waf \
+        distclean configure build install --prefix=/var/tmp/aubio
+
+Installing
+----------
+
+To install the aubio external for puredata on your system, run the following as
+root:
+
+    # make install
+
+Running
+-------
+
+To load the external, start pd as follows
+
+    $ pd -lib aubio
+
+Alternatively, you can create an object [aubio] to initialize the external.
+
+If you want to use the external without installing it, the above command should
+work as expected from the pd-aubio source directory. If needed, set your
+`LD_LIBRARY_PATH` to include the path to the aubio library.