You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by lo...@apache.org on 2014/06/06 18:21:32 UTC

[4/6] git commit: config parser readme skeleton

config parser readme skeleton


Project: http://git-wip-us.apache.org/repos/asf/cordova-lib/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-lib/commit/1f680786
Tree: http://git-wip-us.apache.org/repos/asf/cordova-lib/tree/1f680786
Diff: http://git-wip-us.apache.org/repos/asf/cordova-lib/diff/1f680786

Branch: refs/heads/configparser_module
Commit: 1f6807863e054612bb0459e400548daef467bee5
Parents: 2674a1d
Author: Lorin Beer <lo...@gmail.com>
Authored: Thu Jun 5 15:55:21 2014 -0700
Committer: Lorin Beer <lo...@gmail.com>
Committed: Thu Jun 5 15:55:21 2014 -0700

----------------------------------------------------------------------
 cordova-lib/src/configparser/README.md | 34 +++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-lib/blob/1f680786/cordova-lib/src/configparser/README.md
----------------------------------------------------------------------
diff --git a/cordova-lib/src/configparser/README.md b/cordova-lib/src/configparser/README.md
new file mode 100644
index 0000000..f2f8067
--- /dev/null
+++ b/cordova-lib/src/configparser/README.md
@@ -0,0 +1,34 @@
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+#  KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+-->
+
+# cordova-lib
+Contains npm modules used primarily by [cordova](https://github.com/apache/cordova-cli/) and [plugman](https://github.com/apache/cordova-plugman/).
+
+## Setup
+* Clone this repository onto your local machine. 
+    `git clone https://git-wip-us.apache.org/repos/asf/cordova-lib.git`
+* In terminal, navigate to the inner cordova-lib directory.
+    `cd cordova-lib/cordova-lib`
+* Install dependencies and npm-link
+    `npm install && npm link`
+* Navigate to CLI and Plugman directories and link cordova-lib
+    `cd ../../cordova-cli && npm link cordova-lib && npm install`
+    `cd ../../cordova-plugman && npm link cordova-lib && npm install`