Skip to content

Commit

Permalink
Re-write coho's README.md with a mission statement.
Browse files Browse the repository at this point in the history
  • Loading branch information
agrieve committed Mar 11, 2014
1 parent 9d263bd commit 4bafcc8
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 37 deletions.
49 changes: 13 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

8 changes: 7 additions & 1 deletion coho
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4bafcc8

Please sign in to comment.