From e90953c594934d222f18c85d7cd76d9d45a7a45e Mon Sep 17 00:00:00 2001 From: "Elf M. Sternberg" Date: Wed, 25 Jan 2017 16:39:39 -0800 Subject: [PATCH] Updated README with project status. --- README.md | 34 ++++++++++++++++++++-------------- 1 file changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 6baee54..028ea25 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ +# What: + mp\_suggest is a simple little organizational tool for MP3 collections. I wrote it a few years ago to help me organize my own collection, and when the Hy Programming Language came out, I decided it was time for a minor exercise. Rewriting mp\_suggest in Hy was a perfect opportunity. +# Status: + +**May 28, 2016** This code is **complete**. No further work is being +considered. The TODO file is empty. + +# Details: + mp\_suggest does *not* alter your MP3 files; instead, it prints to stdout a simple bash script that invokes the command-line program id3v2; you can capture that script and run it by @@ -11,6 +20,8 @@ hand, or pipe the output of mp\_suggest through sed to make changes on the fly, or just run the output straight into bash with a unix pipe. +# Notes + Writing mp\_suggest was an interesting exercise in returning to Lisp after all these years. I find that I really enjoyed it (although, honestly, Hy's debugging facilities leave a lot to be @@ -22,22 +33,17 @@ Coffeescript. I like Coffeescript a lot, but I don't get many opportunities to use it professionally, but the sensibilities of Coffeescript (especially Reginald Braithwaite's Ristrettology and his other books on functional programming) heavily influenced the design -decisions I made in mp_suggest. +decisions I made in mp\_suggest. -* Licensing +# Using: - This program is released under the terms of the GNU General Public - License (GNU GPL). +mp\_suggest comes with a complete list of commands that can +be seen by running the command with no arguments. See the man page that +comes with it. - You can find a copy of the license in the file COPYING. +# Licensing -* Using: +This program is released under the terms of the GNU General Public +License (GNU GPL). - mp_suggest comes with a complete list of commands that can be seen by - running the command with no arguments. See the man page that comes - with it. - -* To do: - - The TODO file is empty for a reason. This was mostly an exercise in - writing Hy. +You can find a copy of the license in the file COPYING.