From c4a4db9de7e19a3a03cb9d3b0aba40988d82b32c Mon Sep 17 00:00:00 2001 From: Francois Best Date: Wed, 23 May 2012 00:32:56 +0200 Subject: [PATCH] Added doc. --- res/install_local_mac | 2 ++ res/install_mac | 12 +++++++++++- res/packaging | 9 +++++++++ 3 files changed, 22 insertions(+), 1 deletion(-) diff --git a/res/install_local_mac b/res/install_local_mac index bf517cc..5f9376c 100755 --- a/res/install_local_mac +++ b/res/install_local_mac @@ -1,4 +1,6 @@ #!/bin/bash +# Use this script to install the library directy from the git clone. + if [[ -d /Applications/Arduino.app ]] then diff --git a/res/install_mac b/res/install_mac index 9eaeac1..4e6659a 100755 --- a/res/install_mac +++ b/res/install_mac @@ -1,10 +1,20 @@ #!/bin/bash +# This script installs the Arduino MIDI Library into the Arduino application, +# so that every sketch can include it directly, without having to copy anything. +# +# To install the library, run this script by double-clicking it, +# it should be directly executable and seen as such by Mac OS X. +# If not, open a terminal, cd to the script location, and run ./install_mac +# +# Open the Arduino IDE, and you're ready to go! + +# The script assumes the Arduino application +# is installed in the default location. if [[ -d /Applications/Arduino.app ]] then # Define locations - lib_path=/Applications/Arduino.app/Contents/Resources/Java/libraries/MIDI if [[ -d $lib_path ]] diff --git a/res/packaging b/res/packaging index dbad4b8..33ee9c3 100755 --- a/res/packaging +++ b/res/packaging @@ -1,4 +1,13 @@ #!/bin/bash +# +# Generate an archive with packaged content for easier delivery. +# The generated archive contains: +# - Source files (MIDI.cpp / MIDI.h) +# - Resources (keywords.txt) +# - Documentation (Doxygen) +# - Examples for Arduino IDE +# - Installation scripts + # Create a temporary destination folder mkdir -p temp/doc