From 8e92c70cde9ad6c910a0455d42bdce316ab33ce6 Mon Sep 17 00:00:00 2001 From: fwcd Date: Tue, 17 Oct 2023 22:26:45 +0100 Subject: [PATCH 1/3] Update project description and link to report --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 107e7778..96c61445 100755 --- a/README.md +++ b/README.md @@ -2,7 +2,9 @@ libkeyfinder is a small C++11 library for estimating the musical key of digital audio. It is published under the [GNU General Public License version 3 or later](LICENSE). -It was written by [Ibrahim Shaath](http://ibrahimshaath.co.uk/keyfinder/) who wrote it in 2011 as part of a master's thesis in computer science. A [GUI application](https://github.com/ibsh/is_KeyFinder) to use it is available for [macOS](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-OSX-2-4.zip) and [Windows](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-WIN-1-25.zip), however that is no longer maintained and does not build on contemporary Linux distributions. +The library was written by [Ibrahim Shaath](http://ibrahimshaath.co.uk/keyfinder/) in 2011 as part of a master's project in computer science, ["Estimations of key in digital music recordings"](https://www.ibrahimshaath.co.uk/keyfinder/KeyFinder.pdf). + +A [GUI application](https://github.com/ibsh/is_KeyFinder) to use it is available for [macOS](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-OSX-2-4.zip) and [Windows](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-WIN-1-25.zip). This app is no longer maintained, however, and does not build on contemporary Linux distributions. In 2020, Ibrahim handed over maintenance of libkeyfinder to the [Mixxx DJ software](https://mixxx.org) team who incorporated it into Mixxx as of Mixxx 2.3. If you want to discuss anything related to libkeyfinder with us, please get in touch on the [Mixxx Zulip chat](https://mixxx.zulipchat.com/#narrow/stream/109171-development/topic/KeyFinder). Contributions are welcome by opening pull requests and issues on [GitHub](https://github.com/mixxxdj/libkeyfinder). From dd96ac27c7ed0f84ecec96d9f08c0430d1474ebd Mon Sep 17 00:00:00 2001 From: fwcd Date: Tue, 17 Oct 2023 22:32:08 +0100 Subject: [PATCH 2/3] Add CI badge --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 96c61445..2924ed68 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # libkeyfinder +[![build](https://github.com/mixxxdj/libkeyfinder/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/mixxxdj/libkeyfinder/actions/workflows/build-and-test.yml) + libkeyfinder is a small C++11 library for estimating the musical key of digital audio. It is published under the [GNU General Public License version 3 or later](LICENSE). The library was written by [Ibrahim Shaath](http://ibrahimshaath.co.uk/keyfinder/) in 2011 as part of a master's project in computer science, ["Estimations of key in digital music recordings"](https://www.ibrahimshaath.co.uk/keyfinder/KeyFinder.pdf). From 95f09c1304ef414511cd3e1db1b4035a1fe0fa6c Mon Sep 17 00:00:00 2001 From: fwcd Date: Wed, 18 Oct 2023 11:55:46 +0100 Subject: [PATCH 3/3] Link to original repo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2924ed68..ff30ddab 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ libkeyfinder is a small C++11 library for estimating the musical key of digital audio. It is published under the [GNU General Public License version 3 or later](LICENSE). -The library was written by [Ibrahim Shaath](http://ibrahimshaath.co.uk/keyfinder/) in 2011 as part of a master's project in computer science, ["Estimations of key in digital music recordings"](https://www.ibrahimshaath.co.uk/keyfinder/KeyFinder.pdf). +The library was written by [Ibrahim Shaath](http://ibrahimshaath.co.uk/keyfinder/) in 2011 as part of a master's project in computer science, ["Estimations of key in digital music recordings"](https://www.ibrahimshaath.co.uk/keyfinder/KeyFinder.pdf), and originally hosted [in this repo](https://github.com/ibsh/libKeyFinder). A [GUI application](https://github.com/ibsh/is_KeyFinder) to use it is available for [macOS](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-OSX-2-4.zip) and [Windows](http://www.ibrahimshaath.co.uk/keyfinder/bins/KeyFinder-WIN-1-25.zip). This app is no longer maintained, however, and does not build on contemporary Linux distributions.