« get me outta code hell

Readme - http-music - Command-line music player + utils (not a server!)
about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorliam4 <towerofnix@gmail.com>2017-05-29 20:20:53 +0000
committerliam4 <towerofnix@gmail.com>2017-05-29 20:20:53 +0000
commit37caa6c403d50a22b5bab9f48da8d7fdb526ec3f (patch)
treec78773be4d4d917748b6d34d2d325d38be3d4c1b /README.md
parent7572a9f46ff1438d4199306077c1dacd1233176a (diff)
Readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db3c69a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# `http-music`
+
+A command line program that lets you download music from places and play it.
+It's also decently powerful.
+
+## Using the thing
+
+```bash
+# On the server; that is, the device that holds the media:
+$ cd my_music_folder
+$ python3 -m http.server 1233
+
+# On the client; that is, the device with http-music:
+$ cd http-music
+$ yarn  # to install Node.js dependencies; you'll also need `avconv` and `play` (sox).
+$ node crawl-itunes.js > playlist.json  # Bad script name, right?
+# I think you might need to configure crawl-itunes.js to get the right IP and port..
+$ node play.js  # Go!
+```
+
+**Zomg command line arguments????** — Yes; read the end of the `play.js` file.
+There's a bunch of JS-comment-based documentation there.