Updated README with project status.

This commit is contained in:
Elf M. Sternberg 2017-01-25 16:39:39 -08:00
parent 08fb63fd02
commit e90953c594
1 changed files with 20 additions and 14 deletions

View File

@ -1,9 +1,18 @@
# What:
<code>mp\_suggest</code> 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 <code>mp\_suggest</code> 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:
<code>mp\_suggest</code> does *not* alter your MP3 files; instead, it
prints to stdout a simple <code>bash</code> 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 <code>mp\_suggest</code> through
<code>sed</code> to make changes on the fly, or just run the output
straight into <code>bash</code> with a unix pipe.
# Notes
Writing <code>mp\_suggest</code> 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 <code>mp_suggest</code>.
decisions I made in <code>mp\_suggest</code>.
* Licensing
# Using:
<code>mp\_suggest</code> 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.
# Licensing
This program is released under the terms of the GNU General Public
License (GNU GPL).
You can find a copy of the license in the file COPYING.
* Using:
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.