Permalink
Browse files

updated readme and added license

  • Loading branch information...
1 parent 4bc7e54 commit 6b905a470ca99739592825a337e9d100bd3da5da stevengill committed Jan 31, 2012
Showing with 475 additions and 30 deletions.
  1. +44 −30 README.md
  2. +426 −0 license
  3. +5 −0 test/tests.coffee
View
@@ -1,42 +1,66 @@
-Cordova
+COHO
=======
-These are documenting the manual steps required to make Cordova/PhoneGap Release. Our goal is to automate these as much as possible.
+Coho is a script that automates the release process for building PhoneGap releases. Future releases will hopefully be able to build official Cordova releases.
-Perquisites
-===========
+Prerequisites
+-------------
- Must be run on a Mac with Lion installed
- - Must have joDoc installed
- Must have git setup
+ - Install joDoc
+ - Clone [joDoc](http://github.com/davebalmer/jodoc)
+
+ git clone http://github.com/davebalmer/joDoc.git
+
+ - Add joDoc/ to your path
+
+ Open `~/.bashrc` or `~/.profile` (or whatever you use)
+
+ export PATH=$PATH:~/path/to/joDoc/
+
+ - Install markdown
+
+ # Use your package manager
+ brew install markdown
+ port install markdown
+ aptitude install markdown
+
+ - Install nokogiri (Ruby HTML parser)
+
+ gem install nokogiri
+
+ - Install json (Ruby JSON parser)
+
+ gem install json
Usage
-=====
+-----
- coho 1.3.0
- // creates phonegap-1.3.0.zip
+ coho 1.4.0
+ // creates phonegap-1.4.0.zip
- coho 1.3.0 1.2.0
- // creates phonegap-1.3.0.zip with the changes made since 1.2.0
+ coho 1.4.0 1.3.0
+ // creates phonegap-1.4.0.zip with the changes made since 1.3.0
+
+ make
+ // runs coho 1.4.0 1.3.0 and the unit tests
-### the process
-
+Manual Process
+--------------
1. create a directory
2. download the shit
iOS
-===
- Pull tagged version of cordova-ios
- Check if version file is up to date
- CD into cordova-ios and run make on a Lion machine
- Copy DMG file from dist folder into iOS release folder
-
Android
-=======
- Pull tagged version of cordova-android
- Check if version file is up to date
- CD into directory and run create command
@@ -46,48 +70,38 @@ Android
- Make sure index.html in example/assets/www is correctly referencing phonegap-1.3.0.js
- Copy example folder into android release folder
-
BlackBerry
-==========
- Pull tagged version of cordova-blackberry
- Check if version file is up to date
- CD into cordova-blackberry and run ant dist
- Copy contents of dist directory to blackberry release folder
Windows Phone
-=============
- Pull tagged version of cordova-windows-phone
- Copy contents of cordova-windows-phone into windows phone release directory
Bada
-====
- Pull tagged version of cordova-bada
- Check if version file is up to date
- Copy contents of cordova-bada to bada release folder
-
WebOS
-=====
- Pull tagged version of cordova-webos
- Check if version file is up to date
- Copy contents of cordova-web0s to webOS release folder
-
-Symbian
-=======
+Symbian (Has been deprecated)
- Pull tagged version of cordova-symbian
- Check if version file is up to date
- Copy contents of cordova-symbian to symbian release folder
Docs
-====
- Pull tagged version of cordova-docs
- CD phonegap-docs and run command ./bin/phonegap-docs
- Copy contents of Public folder into docs release folder
-Issues & Concerns
-=================
- - Every project needs to have a VERSION file in it to double check the tagged version (Currently missing in windows-phone and docs). Failing tests are expected.
- - Currently using callback repo for files. Need to switch this to apache git servers but need all the tags for each repo updated first
- - Need to implement shortlog command to create changelog. Will have to take version number and do some string manipulation to get previous version (1.3.0 to 1.2.0) or add it as a parameter of the script
+Issues
+------
+
+Please file all issues at https://github.com/stevengill/coho/issues
Oops, something went wrong.

0 comments on commit 6b905a4

Please sign in to comment.