cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From purplecabb...@apache.org
Subject [1/2] git commit: [CB-3649] Update and add create instructions for WP8 README
Date Wed, 12 Jun 2013 19:04:42 GMT
Updated Branches:
  refs/heads/master 688bbd343 -> f907fa5f1


[CB-3649] Update and add create instructions for WP8 README

- Added Apache license header
- Correct bullet indentention
- Made all links reference links at the end of file
- Added instructions for creating template
- Remove step to copy template since is not included with Cordova
- Made more clear where to find Cordova Template in Visual Studio
- Added section about command line using create
- Bugs section remove Incubator, since Cordova already graduated


Project: http://git-wip-us.apache.org/repos/asf/cordova-wp8/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-wp8/commit/7d5134be
Tree: http://git-wip-us.apache.org/repos/asf/cordova-wp8/tree/7d5134be
Diff: http://git-wip-us.apache.org/repos/asf/cordova-wp8/diff/7d5134be

Branch: refs/heads/master
Commit: 7d5134be077a5bbb3e21c23254ac3f0346d60adc
Parents: 804a1f0
Author: Carlos Santana <csantana23@gmail.com>
Authored: Thu Jun 6 17:30:39 2013 -0400
Committer: Carlos Santana <csantana23@gmail.com>
Committed: Thu Jun 6 17:30:39 2013 -0400

----------------------------------------------------------------------
 README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 73 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-wp8/blob/7d5134be/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 8d772b3..646f7d4 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,99 @@
+<!--
+#
+# 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.
+#
+-->
 Apache Cordova for Windows Phone 8
 ===
 
-Apache Cordova WP8 is a .net application library that lets you create Apache Cordova applications
targeting Windows Phone 8 devices.
-Apache Cordova based applications are, at the core, an application written with web technology:
HTML, CSS and JavaScript.
+- Apache Cordova WP8 is a .net application library that lets you create Apache Cordova applications
targeting Windows Phone 8 devices.
+- Apache Cordova based applications are, at the core, an application written with web technology:
HTML, CSS and JavaScript.
+
+[Apache Cordova][] is a project at The Apache Software Foundation (ASF).
 
 Requires
 ---
 
-- Windows Phone SDK 8 [http://www.microsoft.com/en-us/download/details.aspx?id=35471]
+- [Windows Phone SDK 8][]
 
 
-Getting Started
+Getting Started from Visual Studio Project Template
 ---
 
-- copy the file templates/CordovaStarter-x.x.x.zip to the folder : \My Documents\Visual Studio
2012\Templates\ProjectTemplates\
- - if you have just installed VisualStudio, you should launch it once to create this folder
- - if you prefer, you may add the project instead to the "Silverlight for Windows Phone"
subfolder of "Visual C#".  This is up to you, and only affects where the project template
is shown when creating a new project. Also, You may need to create this folder.
+- Create the Visual Studio Cordova Starter Template
+    - Open the file templates\standalone\CordovaSolution.sln in Visual Studio
+    - From the file menu, select 'Export Template...' 
+    - Choose template type 'Project template'
+    - Give the exported template a name, ex. CordovaStarter-x.x.x will produce CordovaStarter-x.x.x.zip
+- Visual Studio will put a copy of CordovaStarter-x.x.x.zip in \My Documents\Visual Studio
2012\Templates\ProjectTemplates\
+    - if you prefer, you may add the project instead to the "Silverlight for Windows Phone"
subfolder of "Visual C#".  This is up to you, and only affects where the project template
is shown when creating a new project. Also, You may need to create this folder.
 - Launch Visual Studio 2012 and select to create a new project
- - CordovaStarter should be listed as an option, give your new project a name
-  - Note: The description will let you know the version of Cordova you are targetting, if
you have multiple templates.
- - If you do not see it, you may have to select the top level 'Visual C#' to see it
+    - CordovaStarter should be listed under Templates->Other Languages->Visual C#
+    - Give your new project a name
+        - Note: The description will let you know the version of Cordova you are targetting,
if you have multiple templates.
+    - If you do not see it, you may have to select the top level 'Visual C#' to see it or
use the search box and type "Cordova"
 - Build and Run it!
 
 
+Gettings Started from command line
+---
+
+    >.\bin\create PathTONewProject [ PackageName ] [ AppName ]
+
+    >PathTONewProject : The path to where you wish to create the project
+    >PackageName      : The namespace for the project (default is Cordova.Example)
+    >AppName          : The name of the application (default is CordovaAppProj)
+
+    >examples:
+    >.\bin\create C:\Users\anonymous\Desktop\MyProject
+    >.\bin\create C:\Users\anonymous\Desktop\MyProject io.cordova.example CordovaApp
+
+    Launch Visual Studio and open Solution file (C:\Users\anonymous\Desktop\MyProject\MyProject.sln)
+
+    Built and Run it
+
+
+
 Known Problem Areas
 ---
 
-Many of the Media APIs will not function as expected when debugging while connect to the
device with the Zune software.
-To get around this, you need to use the Windows Phone Connect tool. For details, please check
out this [MSDN blog article](http://blogs.msdn.com/b/jaimer/archive/2010/11/03/tips-for-debugging-wp7-media-apps-with-wpconnect.aspx).
+- Many of the Media APIs will not function as expected when debugging while connect to the
device with the Zune software.
+- To get around this, you need to use the Windows Phone Connect tool. For details, please
check out this [MSDN blog article][Tips for debugging WP7 media apps with WPConnect].
 
 
 BUGS?
 -----
-File them at Apache Incubator
-https://issues.apache.org/jira/browse/CB
+
+- File them at the [Apache Cordova Issue Tracker][]
+
 
 Further Reading
 ---
 
-- [http://docs.phonegap.com](http://docs.phonegap.com)
-- [http://wiki.phonegap.com](http://wiki.phonegap.com)
+- [Apache Cordova Documentation][]
+- [Apache Cordova Wiki][]
+
+
+[Windows Phone SDK 8]: http://www.microsoft.com/en-us/download/details.aspx?id=35471 "Download
Windows Phone SDK 8"
+[Tips for debugging WP7 media apps with WPConnect]: http://blogs.msdn.com/b/jaimer/archive/2010/11/03/tips-for-debugging-wp7-media-apps-with-wpconnect.aspx
"Tips for debugging WP7 media apps with WPConnect"
+
+[Apache Cordova]: http://cordova.io "Apache Cordova"
+[Apache Cordova Issue Tracker]: https://issues.apache.org/jira/browse/CB "Apache Cordova
Issue Tracker"
+[Apache Cordova Documentation]: http://cordova.io/docs "Apache Cordova Documentation"
+[Apache Cordova Wiki]: http://wiki.apache.org/cordova "Apache Cordova Wiki"
+


Mime
View raw message