Adding comments; Fixed #185

build_tools/auth.php

@@ -1,10 +1,18 @@
 <?php
 
+/**
+ * Spotify Authentication proxy
+ *
+ * To use:
+ * 1. Create a Spotify App (https://developer.spotify.com/my-applications), and paste in your credentials below
+ * 2. Save this script to a publicly-accessible server
+ * 3. Set config in mopidy.conf to point to this script
+ **/
+
 // Spotify app credentials
-// Create your application here: https://developer.spotify.com/my-applications
 define('CLIENT_ID','YOUR_ID_HERE');
 define('CLIENT_SECRET','YOUR_SECRET_HERE');
-define('REDIRECT_URI','YOUR_REDIRECT_URI_HERE (to this file)');
+define('REDIRECT_URI','YOUR_REDIRECT_URI_HERE');
 
 // Allow cross-domain requests
 header("Access-Control-Allow-Origin: *");

build_tools/build.js

@@ -1,4 +1,13 @@
 
+/**
+ * Iris builder 
+ *
+ * Collates all static elements into the mopidy_iris Python package folder
+ * We also amend all related files with the latest build version
+ *
+ * To run, execute npm run dev|build|prod|release
+ **/
+
 var fs = require('fs');
 var copydir = require('copy-dir');
 

build_tools/build.sh

@@ -1,27 +0,0 @@
-#!/bin/bash
-
-# process production html
-BUILD=$(date +%s)
-VERSION=$(cat VERSION.md)
-
-echo -e "Building $VERSION ($BUILD)"
-
-# copy assets
-echo -e Copying assets $SERVER
-rsync -avr src/assets/ mopidy_iris/static/assets/ 2>&1 >/dev/null
-
-# create HTML files
-echo -e Copying index.html
-cp src/index.html mopidy_iris/static/index.html
-
-echo -e "Setting version in static HTML"
-sed -i 's/VERSION_HERE/'$VERSION'/g' mopidy_iris/static/index.html
-sed -i 's/BUILD_HERE/'$BUILD'/g' mopidy_iris/static/index.html
-
-echo -e "Setting version in Python"
-sed -i "/__version__ = '/c\__version__ = '"$VERSION"'" mopidy_iris/__init__.py
-
-echo -e "Setting version in NPM"
-sed -i '/	"version": "/c\	"version": "'$VERSION'",' package.json
-
-echo -e "\x1b[32;01m"Done!"\x1b[39;49;00m"

build_tools/release.sh

@@ -1,5 +1,12 @@
 #!/bin/bash
 
+##
+# Release Iris
+#
+# This provides shortcuts to the Git commands during a release. Essentially it commits
+# everything and creates a new tag, based on the current version number.
+##
+
 VERSION=$(cat VERSION.md)
 
 echo -e "Releasing $VERSION"