search

tidalcycles / tidal-midi

This package and method of using MIDI in Tidal is obsolete. Please use SuperDirt MIDI instead.
GNU General Public License v3.0
74 stars 36 forks source link

Update documentation to 0.8 #15

Closed kindohm closed 8 years ago

kindohm commented 8 years ago

Big documentation change. Attempted to update most of the tidal-midi docs to 0.8. @yaxu expressed an interest in reviewing this content later this weekend. I decided to do a PR now and we can review/discuss in this thread. These changes aren't comprehensive and there are probably gaps. I'm hoping future PR's can help fill in the gaps. Better to make improvements as we can than wait for everything all at once (?).

Arguably, this information should be on tidalcycles.org. I thought it would be easier to review and revise these changes in plain .md files for now. We can decide what to do with this content in the near future: either migrate it to tidalcycles.org or link to it from tidalcycles.org.

lennart commented 8 years ago

hey mike, thx for this update!

I think this is really detailed and should hopefully ease the pain of getting started for people new to tidal-midi (and also tidal).

One minor note though, you first tell people how they can find out which name they need to enter for midiSetters, but you explain how to evaluate lines in the editor afterwards (in boot tidal-midi). Since we should assume people use atom by default, your hint with Shift+Enter should be placed where you first say "evaulate each line separately" (maybe we can even tell this twice)

I'll test your instructions with atom as soon as I find the time!

kindohm commented 8 years ago

@lennart thanks for that input. I agree, that text could be cleaned up a bit.

Also, the doc should also state that tidal-midi requires the latest version of tidal.

lennart commented 8 years ago

yes and, if not yet noted somewhere, dependencies for linux: apt-get install libasound2-dev and libportmidi-dev

on osx it's brew install portmidi

on windows you would be the one I'd ask!

kindohm commented 8 years ago

@lennart ha, interesting, I never thought of portmidi. This is tricky for me on Windows. I have portmidi installed as part of classic Dirt on Cygwin but I don't think I have it installed any other way. I don't believe cabal install tidal-midi would end up looking at Cygwin for the portmidi bits. I could remove Cygwin and find out. I don't recall ever installing a portmidi dependency for tidal-midi.

kindohm commented 8 years ago

added info about prerequisites