cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From agri...@apache.org
Subject [2/2] git commit: Re-write coho's README.md with a mission statement.
Date Tue, 11 Mar 2014 18:48:13 GMT
Re-write coho's README.md with a mission statement.


Project: http://git-wip-us.apache.org/repos/asf/cordova-coho/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-coho/commit/4bafcc86
Tree: http://git-wip-us.apache.org/repos/asf/cordova-coho/tree/4bafcc86
Diff: http://git-wip-us.apache.org/repos/asf/cordova-coho/diff/4bafcc86

Branch: refs/heads/master
Commit: 4bafcc8666f03f8191f5b8d1f98da3d3b205e25b
Parents: 9d263bd
Author: Andrew Grieve <agrieve@chromium.org>
Authored: Tue Mar 11 14:47:51 2014 -0400
Committer: Andrew Grieve <agrieve@chromium.org>
Committed: Tue Mar 11 14:47:51 2014 -0400

----------------------------------------------------------------------
 README.md | 49 +++++++++++++------------------------------------
 coho      |  8 +++++++-
 2 files changed, 20 insertions(+), 37 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/4bafcc86/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index eda97d3..0e73dbf 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,22 @@
-COHO
-=======
+# COHO
 
-Coho is a script that contains commands that make it easier to work with Cordova's many repositories.
+This repository has the following purposes:
 
-Prerequisites
--------------
- - Have node installed
- - Must have git setup
- - Must install node dependencies via `npm install`
+1. To hold release processes documentation (`docs/*`)
 
-If you get the error:
-    Error: Cannot find module 'optimist'
-then you haven't run `npm install` yet.
+2. To hold release automation scripts
+  - e.g. coho create-archive && coho verify-archive
+  - e.g. CrowdIn scripts
 
-Suggested way to install `node` is to use `nvm`:
+3. To hold committer process documentation
+  - e.g. ProcessingPullRequests
 
-    curl https://raw.github.com/creationix/nvm/master/install.sh | sh
-    source ~/.bash_profile
-    nvm install 0.10
-    nvm alias default 0.10
+4. To hold generally useful dev scripts
+  - e.g. coho repo-clone
+  - e.g. coho --help
 
-Getting Coho
-------------
 
-    mkdir cordova && cd cordova && git clone https://git-wip-us.apache.org/repos/asf/cordova-coho.git
-
-Usage
------
-`./coho --help`
-
-Examples
---------
-`./cordova-coho/coho repo-clone -r plugins -r mobile-spec -r android -r ios -r cli`
-
-`./cordova-coho/coho repo-update -r auto`
+## How to Clone
 
-`./cordova-coho/coho foreach -r plugins "git checkout master"`
-
-`./cordova-coho/coho foreach -r plugins "git clean -fd"`
-
-`./cordova-coho/coho list-repos`
-
-`./cordova-coho/coho last-week --me`
+    mkdir cordova && cd cordova && git clone https://git-wip-us.apache.org/repos/asf/cordova-coho.git
 

http://git-wip-us.apache.org/repos/asf/cordova-coho/blob/4bafcc86/coho
----------------------------------------------------------------------
diff --git a/coho b/coho
index b8f9858..f84f5b8 100755
--- a/coho
+++ b/coho
@@ -2052,7 +2052,13 @@ function main() {
     for (var i = 0; i < commandList.length; ++i) {
         usage += '    ' + commandList[i].name + ': ' + commandList[i].desc + '\n';
     }
-    usage += '\nFor help on a specific command: $0 command --help';
+    usage += '\nFor help on a specific command: $0 command --help\n\n';
+    usage += 'Some examples:\n';
+    usage += '    ./cordova-coho/coho repo-clone -r plugins -r mobile-spec -r android -r
ios -r cli\n';
+    usage += '    ./cordova-coho/coho repo-update\n';
+    usage += '    ./cordova-coho/coho foreach -r plugins "git checkout master"\n';
+    usage += '    ./cordova-coho/coho foreach -r plugins "git clean -fd"\n';
+    usage += '    ./cordova-coho/coho last-week --me';
 
     var command;
     var argv = optimist


Mime
View raw message