V0 2

.gitignore

@@ -1,14 +1,12 @@
 .DS_Store
 .project
 doc
-distribution/
+docs
+sparkup-*/
+*.zip
 .sourcescribe_index
 *.swp
 *.swo
 *.pyc
 cscope.out
 *~
-
-# Distribution files
-# */sparkup
-# */sparkup.py

AUTHORS

@@ -0,0 +1,16 @@
+Credits
+-------
+
+Sparkup is written by Rico Sta. Cruz and is released under the MIT license.
+
+This project is inspired by [Zen Coding](http://code.google.com/p/zen-coding/) of
+[Vadim Makeev](http://pepelsbey.net). The Zen HTML syntax is forward-compatible with Sparkup
+(anything that Zen HTML can parse, Sparkup can too).
+
+The following people have contributed code to the project:
+
+ - Guillermo O. Freschi (Tordek @ github)
+   Bugfixes to the parsing system
+
+ - Eric Van Dewoestine (ervandew @ github)
+   Improvements to the VIM plugin

CHANGELOG

@@ -0,0 +1,5 @@
+v0.2
+ - New directory structure for the source tree
+
+v0.1.3
+ - ..

Makefile

@@ -1,39 +1,79 @@
-SPARKUP_PY=sparkup
-VERSION=`date '+%Y%m%d'`
-README=README.md
+# Sparkup makefile
+# ================
 
-.PHONY: all textmate vim textmate-dist vim-dist plugins plugins-pre generic all-dist
-all: plugins
+# Account for incremental version numbers (e.g., 0.3.5-20091229)
+VERSION    = $(subst {date},${shell date +%Y%m%d},$(shell cat VERSION))
+ROOT      := $(PWD)
 
-plugins-pre:
-	mkdir -p distribution
+# Paths
+PLUGINS_PATH      = plugins
+DOC_PATH          = docs
+DISTRIB_PATH      = sparkup-${VERSION}
+DISTRIB_PLUGINS   = ${DISTRIB_PATH}/textmate ${DISTRIB_PATH}/vim ${DISTRIB_PATH}/generic ${DISTRIB_PATH}/docs
+DISTRIB_FILES     = ${DISTRIB_PLUGINS} ${DISTRIB_PATH}/readme.txt
 
-plugins: plugins-pre all-dist
+# Files
+README      = README.md
+SPARKUP_PY  = ${DISTRIB_PATH}/sparkup.py
+FINAL_ZIP   = sparkup-${VERSION}.zip
 
-textmate-dist: textmate
-	cd TextMate && zip -9r ../distribution/sparkup-textmate-${VERSION}.zip . && cd ..
+.PHONY: all distrib ${DISTRIB_PATH} ${DISTRIB_PLUGINS} distrib_cleanup ${SPARKUP_PY} ${DOC_PATH}
+all: ${FINAL_ZIP}
+	@echo ------
+	@echo  
+	@echo Done!
+	@echo  
+	@echo . - ${FINAL_ZIP}
+	@echo .   This is the redistributable ZIP file.
+	@echo .
+	@echo . - ${DISTRIB_PATH}/
+	@echo .   The plugins are here, ready-to-use.
 
-vim-dist: vim
-	cd vim && zip -9r ../distribution/sparkup-vim-${VERSION}.zip . && cd ..
+# Final .zip
+${FINAL_ZIP}: distrib
+	cd ${DISTRIB_PATH} && zip -9r "${ROOT}/$@" ${DISTRIB_FILES:${DISTRIB_PATH}/%=%} \
+ 	  --exclude */.DS_Store --exclude */Thumbs.db --exclude */*.pyc
 
-generic-dist: generic
-	cd generic && zip -9r ../distribution/sparkup-generic-${VERSION}.zip . && cd ..
+# Distribution path
+distrib: ${DISTRIB_PATH} ${DISTRIB_FILES} distrib_cleanup
 
-all-dist:
-	zip -9r distribution/sparkup-${VERSION}.zip generic vim textmate README.md -x */sparkup-readme.txt
-	cp distribution/sparkup-${VERSION}.zip distribution/sparkup-latest.zip
+distrib_cleanup:
+	rm ${SPARKUP_PY}
 
-generic:
-	cat sparkup.py > generic/sparkup
-	chmod +x generic/sparkup
-	#cp ${README} generic/sparkup-readme.txt
+${DISTRIB_PATH}:
+	mkdir -p "$@"
 
-textmate:
-	mkdir -p TextMate/Sparkup.tmbundle/Support
-	cp ${SPARKUP_PY} TextMate/Sparkup.tmbundle/Support/sparkup.py
-	#cp ${README} TextMate/sparkup-readme.txt
+${DISTRIB_PATH}/readme.txt: ${README}
+	cp ${README} "$@"
+
+${DISTRIB_PATH}/textmate: ${SPARKUP_PY}
+	mkdir -p "$@"
+	cp -R "${PLUGINS_PATH}/textmate" "${DISTRIB_PATH}"
+	mkdir -p "$@/Sparkup.tmbundle"
+	mkdir -p "$@/Sparkup.tmbundle/Support"
+	cp ${SPARKUP_PY} \
+	   "$@/Sparkup.tmbundle/Support/sparkup.py"
+
+${DISTRIB_PATH}/vim: ${SPARKUP_PY}
+	mkdir -p "$@"
+	cp -R "${PLUGINS_PATH}/vim" "${DISTRIB_PATH}"
+	mkdir -p "$@/ftplugin/html"
+	cp ${SPARKUP_PY} "$@/ftplugin/html/sparkup.py"
+
+${DISTRIB_PATH}/generic: ${SPARKUP_PY}
+	mkdir -p "$@"
+	cp -R "${PLUGINS_PATH}/generic" "${DISTRIB_PATH}"
+	cat ${SPARKUP_PY} > "$@/sparkup"
+	chmod +x "$@/sparkup"
+
+${DISTRIB_PATH}/docs: ${DOC_PATH}
+	rm -f "$@"
+	cp -R ${DOC_PATH} "$@"
+
+${DOC_PATH}:
+	ss
+
+# Sources
+${SPARKUP_PY}:
+	cat "src/sparkup/sparkup.py" | sed 's/^VERSION.*$$/VERSION = "${VERSION}"/' > $@
 
-vim:
-	mkdir -p vim/ftplugin/html
-	cp ${SPARKUP_PY} vim/ftplugin/html/sparkup.py
-	#cp ${README} vim/sparkup-readme.txt

README.md

@@ -15,116 +15,15 @@ and TextMate are currently included.
 A short screencast is available here: 
 [http://www.youtube.com/watch?v=Jw3jipcenKc](http://www.youtube.com/watch?v=Jw3jipcenKc)
 
-Usage and installation
-----------------------
-You may download Sparkup from Github. [Download the latest version here](http://github.com/rstacruz/sparkup/downloads).
+Build instructions
+------------------
 
- - **TextMate**: Simply double-click on the `Sparkup.tmbundle` package in Finder. This
-   will install it automatically. In TextMate, open an HTML file (orset the document type to
-   HTML) type in something (e.g., `#header > h1`), then press `Ctrl` + `E`. Pressing `Tab`
-   will cycle through empty elements.
-
- - **VIM**: See the `vim/README.txt` file for details.
-
- - **Others/command line use**: You may put `sparkup` in your `$PATH` somewhere. You may then
-   invoke it by typing `echo "(input here)" | sparkup`, or `sparkup --help` for a list of commands.
-
-Credits
--------
-
-Sparkup is written by Rico Sta. Cruz and is released under the MIT license.
-
-This project is inspired by [Zen Coding](http://code.google.com/p/zen-coding/) of
-[Vadim Makeev](http://pepelsbey.net). The Zen HTML syntax is forward-compatible with Sparkup
-(anything that Zen HTML can parse, Sparkup can too).
-
-The following people have contributed code to the project:
-
- - Guillermo O. Freschi (Tordek @ github)
-   Bugfixes to the parsing system
-
- - Eric Van Dewoestine (ervandew @ github)
-   Improvements to the VIM plugin
-
-Examples
---------
-
-**`div`** expands to:
-    <div></div>
-
-**`div#header`** expands to:
-    <div id="header"></div>
-
-**`div.align-left#header`** expands to:
-    <div id="header" class="align-left"></div>
-
-**`div#header + div#footer`** expands to:
-    <div id="header"></div>
-    <div id="footer"></div>
-
-**`#menu > ul`** expands to:
-    <div id="menu">
-        <ul></ul>
-    </div>
-
-**`#menu > h3 + ul`** expands to:
-    <div id="menu">
-        <h3></h3>
-        <ul></ul>
-    </div>
-
-**`#header > h1{Welcome to our site}`** expands to:
-    <div id="header">
-        <h1>Welcome to our site</h1>
-    </div>
-
-**`a[href=index.html]{Home}`** expands to:
-    <a href="index.html">Home</a>
-
-**`ul > li*3`** expands to:
-    <ul>
-        <li></li>
-        <li></li>
-        <li></li>
-    </ul>
-
-**`ul > li.item-$*3`** expands to:
-    <ul>
-        <li class="item-1"></li>
-        <li class="item-2"></li>
-        <li class="item-3"></li>
-    </ul>
-
-**`ul > li.item-$*3 > strong`** expands to:
-    <ul>
-        <li class="item-1"><strong></strong></li>
-        <li class="item-2"><strong></strong></li>
-        <li class="item-3"><strong></strong></li>
-    </ul>
-
-**`table > tr*2 > td.name + td*3`** expands to:
-    <table>
-        <tr>
-            <td class="name"></td>
-            <td></td>
-            <td></td>
-            <td></td>
-        </tr>
-        <tr>
-            <td class="name"></td>
-            <td></td>
-            <td></td>
-            <td></td>
-        </tr>
-    </table>
-
-**`#header > ul > li < p{Footer}`** expands to:
-    <!-- The < symbol goes back up the parent; i.e., the opposite of >. -->
-    <div id="header">
-        <ul>
-            <li></li>
-        </ul>
-        <p>Footer</p>
-    </div>
+The files in the source tree are not useable straight away: you need to build the plugins
+first. Simple type `make` (assuming you have GNU make installed) in the project's root.
 
+What it will do:
 
+ - Create a directory called `sparkup-<version>/`
+ - Put the packaged, ready-to-use plugins there
+ - Inject the version number (from the file `VERSION`) to the copies of sparkup.py in that directory
+ - Create a redistributable ZIP file (`sparkup-<version>.zip`)

VERSION

@@ -0,0 +1 @@
+v0.1.99-{date}