quad / moxie

Makes mixtapes!

This URL has Read+Write access

moxie / README.md
raw normal view history
c0f4403c » quad 2008-12-18 Initial cut at a README file. 1 moxie makes mixtapes!
2 =====================
3
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 4 Remember [muxtape][mt]? Yeah, that was nice.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 5
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 6 [moxie][mx] is like that but for _UNIX nerds_.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 7
8 Ok, that's cool. I'm not a programmer though...
9 -----------------------------------------------
10
11 No one's perfect. :-) We got you covered.
12
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 13 1. Use [setuptools][st]!
c0f4403c » quad 2008-12-18 Initial cut at a README file. 14
15 $ easy_install moxie
16
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 17 [Some people][packaging] prefer [pip][pip]. You might be one of those people.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 18
19 $ pip install moxie
20
21 We swing both ways.
22
23 2. Make a directory full of MP3s!
24
25 $ ls
26 01 Act 1_ Eternal Sunshine (the pledge).mp3
27 02-abdominal-breathe_later.mp3
28 Blizzard - Village Theme (Diablo I).mp3
29 cells-sincity.mp3
30 Chromeo-Fancy.mp3
31 prefuse73-megachoppedsuite.mp3
32 Rihanna feat. Jay-Z - Umbrella (Instrumental).mp3
33
fccc4ff3 » quad 2008-12-18 Improve the README language... 34 Oh jeez, whose is that?
c0f4403c » quad 2008-12-18 Initial cut at a README file. 35
fccc4ff3 » quad 2008-12-18 Improve the README language... 36 3. Test it out...
c0f4403c » quad 2008-12-18 Initial cut at a README file. 37
38 $ moxie-test
39 http://127.0.0.1:8080/
40
41 Almost perfect! Except, that text at the top could be improved.
42
fccc4ff3 » quad 2008-12-18 Improve the README language... 43 4. Make a `README` file:
c0f4403c » quad 2008-12-18 Initial cut at a README file. 44
45 $ cat > README
46 One Red Mixtape
47 Made by [this guy](http://oneredpaperclip.blogspot.com/)!
48
fccc4ff3 » quad 2008-12-18 Improve the README language... 49 A title. And a subtitle!
c0f4403c » quad 2008-12-18 Initial cut at a README file. 50
56d5a425 » quad 2008-12-18 Improve the README file aft... 51 Did I mention you can use [Markdown][md] with the subtitle? I probably
52 should have.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 53
56d5a425 » quad 2008-12-18 Improve the README file aft... 54 5. Use `local.css` if you don't like red.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 55
56 $ cat > local.css
57 div#header {
58 color: white;
59 background-color: black;
60 }
61
fccc4ff3 » quad 2008-12-18 Improve the README language... 62 How post-ironic: a black and white mixtape entitled "One _Red_ Mixtape."
56d5a425 » quad 2008-12-18 Improve the README file aft... 63
64 6. `moxie-static` to wrap that sucker up.
c0f4403c » quad 2008-12-18 Initial cut at a README file. 65
66 $ moxie-static --verbose
67 Wrote index.html
68 Wrote xspf
69 Wrote MusicPlayer.swf
70 Wrote style.css
71 Wrote jquery-1.2.6.min.js
72 Wrote moxie.js
73 Wrote expressInstall.swf
74 Wrote swfobject.js
75
fccc4ff3 » quad 2008-12-18 Improve the README language... 76 7. I donno. Put it on a web server someplace?
c0f4403c » quad 2008-12-18 Initial cut at a README file. 77
78 Hey, that was helpful. But I'm a hacker!
79 ----------------------------------------
80
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 81 Oh ho! Well, just a couple recommendations:
82
83 * [Ditz][d], a fine issue tracker.
84 * [git][g] for `git://github.com/quad/moxie.git`
4668a322 » quad 2008-12-18 Added note for lame and sco... 85 * [lame][l] to make test data.
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 86 * [MTASC][m] so you can compile **The Flash**.
debef033 » quad 2008-12-18 Remove some italics in the ... 87 * [nose][n] for all those unittests we forget to write.
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 88 * [SCons][sc] is better than make.
89 * [virtualenv][ve]. This is our Opinionated Requirement.
90
91 I'm hesitant to ask; but, you know to use `apt`/`emerge`/`yum` and friends.
92 Right?
93
94 $ git clone git://github.com/quad/moxie.git src
95
96 $ virtualenv moxie
97
98 $ . moxie/bin/activate
99
100 (moxie)$ cd src/
101 (moxie)$ ./setup.py develop
4668a322 » quad 2008-12-18 Added note for lame and sco... 102 (moxie)$ scons
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 103 (moxie)$ ./setup.py test
104
105 Terminal diarrhea throughout this.
106
107 (moxie)$ moxie-test
108 http://127.0.0.1:8080/
109
110 **IT WORKS!**
111
88071b15 » quad 2008-12-18 Made the demo. text in the ... 112 (moxie)$ ditz status
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 113 unassigned 0/ 1 bugfix, 0/ 2 features, 0/ 0 tasks
114
fccc4ff3 » quad 2008-12-18 Improve the README language... 115 Now get to work.
116
117 xoxo
118
46bde6b3 » quad 2008-12-18 Improve the README language... 119 -- la moxie comunidad hacker
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 120
121 [mt]: http://muxtape.com/ "Muxtape"
ac4d3cb2 » quad 2008-12-18 Fixed PyPI URL in README. 122 [mx]: http://pypi.python.org/pypi/moxie "Python Package Index : moxie"
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 123 [st]: http://peak.telecommunity.com/DevCenter/EasyInstall "EasyInstall"
c0f4403c » quad 2008-12-18 Initial cut at a README file. 124 [packaging]: http://www.b-list.org/weblog/2008/dec/14/packaging/ "James Bennett : On Packaging"
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 125 [pip]: http://pip.openplans.org/ "pip documentation"
c0f4403c » quad 2008-12-18 Initial cut at a README file. 126 [md]: http://daringfireball.net/projects/markdown/ "Daring Fireball: Markdown"
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 127 [d]: http://ditz.rubyforge.org/ "Ditz"
128 [g]: http://git.or.cz/ "Git - Fast Version Control System"
4668a322 » quad 2008-12-18 Added note for lame and sco... 129 [l]: http://lame.sourceforge.net/ "LAME MP3 Encoder"
0e718e32 » quad 2008-12-18 Fill out a developer's sect... 130 [m]: http://www.mtasc.org/ "Motion-Twin"
131 [n]: http://somethingaboutorange.com/mrl/projects/nose/ "nose: a discovery-based unittest extension"
132 [sc]: http://www.scons.org/ "SCons: A software construction tool"
133 [ve]: http://pypi.python.org/pypi/virtualenv "Python Package Index : virtualenv"