cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jan...@apache.org
Subject [cordova-coho] branch master updated: README small changes
Date Wed, 06 Dec 2017 14:42:00 GMT
This is an automated email from the ASF dual-hosted git repository.

janpio pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cordova-coho.git


The following commit(s) were added to refs/heads/master by this push:
     new fc77d1f  README small changes
fc77d1f is described below

commit fc77d1fea97f2ea16a449d2702235afb7b7b856f
Author: Jan Piotrowski <piotrowski+github@gmail.com>
AuthorDate: Wed Dec 6 15:41:59 2017 +0100

    README small changes
    
    reword
    reformat
    move around
---
 README.md | 29 +++++++++++++++--------------
 1 file changed, 15 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index b7a30bc..14c4e70 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@
 
 # Cordova Coho
 
-> The command line tool to for Apache Cordova contributors to manage [ Apache Cordova](http://cordova.apache.org)
repositories, and to help with releases and pull requests.
+> Command line tool for Apache Cordova contributors to manage [Apache Cordova](http://cordova.apache.org)
repositories, and to help with releases and pull requests.
 
 This repository has the following purposes:
 
@@ -52,14 +52,16 @@ npm install -g cordova-coho
 
 On Mac OS X / Linux, if you didn't use a node version manager like `nvm` or `n`, you might
have to run the command using `sudo`.    
 
-## Alternately, you could also clone & Use `coho`
+## Alternately, you could also clone & use `coho`
 
-    mkdir -p cordova
-    cd cordova
-    git clone https://git-wip-us.apache.org/repos/asf/cordova-coho.git
-    cd cordova-coho
-    npm install
-    npm link # Might need sudo for some configurations
+```bash
+mkdir -p cordova
+cd cordova
+git clone https://git-wip-us.apache.org/repos/asf/cordova-coho.git
+cd cordova-coho
+npm install
+npm link # Might need sudo for some configurations
+```
 
 # Cloning/Updating Cordova repositories
 
@@ -71,7 +73,6 @@ coho repo-update -g -r all
 
 `repo-update` will clone a repo if it is missing -- if it exists, it updates it.
 
-
 The `all` repo id will clone **all** Apache Cordova repositories into the current working
directory. 
 
 # Docs
@@ -91,18 +92,18 @@ To see valid repo ids and repo group ids for use with Coho, use the `list-repos`
 
     coho list-repos    
 
+## Note about global context
+
+Note that for some commands you may need to use the `-g` or `--global` flag to work in an
npm global context, since coho was originally designed for use in another context.
 
 # Contributing
 Cordova is an open source Apache project and contributors are needed to keep this project
moving forward. Learn more on 
 [how to contribute on our website][contribute]. 
 
-# TO-DO + Issues
+## Issues
 
 If you find issues with this tool, please follow our guidelines for [reporting issues]. 
-We do not use github issue system as an Apache project, we have a JIRA issue management system
which covers over 50+ cli, platform, 
-plugin repos in the Cordova project. Use the "cordova-coho" component for Cordova Coho issues.
-
-Note that for some commands you may need to use the `-g` or `--global` flag to work in an
npm global context, since coho was originally designed for use in another context.
+We do not use the GitHub issue system as an Apache project, we have a JIRA issue management
system which covers over 50+ CLI, platform, and plugin repos in the Cordova project. Use the
"cordova-coho" component for Cordova Coho issues.
 
 [Contribute]: http://cordova.apache.org/contribute/
 [Reporting issues]: http://cordova.apache.org/contribute/issues.html

-- 
To stop receiving notification emails like this one, please contact
['"commits@cordova.apache.org" <commits@cordova.apache.org>'].

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message