Browse Source

Add README

Matt Baer 3 months ago
parent
commit
b7e276966b
1 changed files with 62 additions and 0 deletions
  1. 62
    0
      README.md

+ 62
- 0
README.md View File

@@ -0,0 +1,62 @@
1
+# CD-R 700mb
2
+
3
+Before Spotify, Apple Music, Amazon Music Unlimited, Amazon Music HD, Google Play Music, Tidal, Deezer, Pandora, Idagio, LiveXLive, Primephonic, SiriusXM Essential, SiriusXM Premier, and YouTube Music, we listened to mixtapes. We compiled tracks on iTunes and burned them onto CD-Rs. We traded them with each other. We freely listened in our car or at home or with our portable CD player. And it was good.
4
+
5
+Today we might spend an eternity making the perfect playlist for someone special, only to learn they're on the Z Music Unlimited service while you're on X Music Basic. Now, vendor lock-in means love lock-out. Our connections are disconnected. Our romantic hopes aren't high enough for the surrounding paywalls. What can we do?
6
+
7
+## A Modern Mixtape
8
+
9
+This is a static site generator for "burning" a modern mixtape. It's platform-independent and won't get scratched up in your car.
10
+
11
+Run this program inside a directory of music files to produce a bare-bones HTML page that will simply play the music for someone. Upload it all to your website, and share the URL. Boom, you have a mixtape.
12
+
13
+This only takes care of "burning the CD," if you will -- then it's up to you to make it special, like you would a normal mixtape. Add track notes, make it look cool or funky, do _something_ that takes a little more effort than sharing a freaking Spotify playlist. All this tech convenience has made us lazy and boring. So make something interesting! Show someone that they **mean something** to you!
14
+
15
+## The Process
16
+
17
+First, compile a collection of music files you'd like to put on a mixtape, and rename them according to the order you want, where each file name starts with a two-digit track number (i.e. `01`, `02`, ... `10`, `11`).
18
+
19
+Of course, THIS PROGRAM IS FOR ILLUSTRATIVE PURPOSES ONLY AND SHOULD NOT BE USED TO DISTRIBUTE COPYRIGHTED MATERIAL YOU DO NOT OWN THE RIGHTS TO.
20
+
21
+## `cdr` Usage
22
+
23
+1. Install `cdr` with `go get github.com/thebaer/cdr`
24
+1. Create a directory for your playlist
25
+1. Add audio files into the directory
26
+1. Make sure they're named in the order you want, and start with a two-digit track number, e.g. `01 - Track 1.mp3`
27
+1. Run `cdr clean` in this directory to standardize the file names based on their metadata (supports ID3, MP4, OGG, FLAC)
28
+1. Run `cdr burn` in this directory to generate your mixtape page
29
+1. Open your new `index.html` in your browser!
30
+
31
+This gives you the basic HTML. Now have fun with it.
32
+
33
+### Over-achievers
34
+
35
+You can also tweak the original template _before_ it generates the final page.
36
+
37
+1. Copy `mixtape.tmpl` into your mixtape directory
38
+1. Edit this file to your liking, being sure to retain the `{{template ...}}` lines in the file
39
+1. Run `cdr burn` -- it'll generate your page from this template instead of the default! 
40
+
41
+## Commands
42
+
43
+```
44
+NAME:
45
+   CD-R 700MB - A static mixtape site generator
46
+
47
+USAGE:
48
+   cdr [global options] command [command options] [arguments...]
49
+
50
+VERSION:
51
+   v1.0
52
+
53
+COMMANDS:
54
+   burn     generate the static mixtape site
55
+   preview  serve the mixtape site
56
+   clean    clean and organize audio files in the current directory
57
+   help, h  Shows a list of commands or help for one command
58
+
59
+GLOBAL OPTIONS:
60
+   --help, -h     show help (default: false)
61
+   --version, -v  print the version (default: false)
62
+```