cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-11347) Document Platform API
Date Mon, 03 Sep 2018 14:13:22 GMT

    [ https://issues.apache.org/jira/browse/CB-11347?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16602216#comment-16602216
] 

ASF GitHub Bot commented on CB-11347:
-------------------------------------

janpio closed pull request #2: CB-11347: a bit more documentation around platform API
URL: https://github.com/apache/cordova-test-platform/pull/2
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/README.md b/README.md
index afaf50d..efc10c0 100644
--- a/README.md
+++ b/README.md
@@ -21,14 +21,27 @@
 
 # cordova-test-platform
 
-This repo contains the code for an [Apache Cordova](http://cordova.apache.org) platform that
allows you to build applications that target NOTHING. This platform is purely for testing,
although it is also a good resource to see the minimum requirements to implement a new platform.
-
+This repo contains the code for an [Apache Cordova](http://cordova.apache.org)
+platform that allows you to build applications that target NOTHING. This
+platform is purely for testing, although it is also a good resource to see the
+minimum requirements to implement a new platform.
 
 [Apache Cordova](http://cordova.apache.org) is a project of [The Apache Software Foundation
(ASF)](http://apache.org)
 
+# How to Use This
+
+This repository contains a reference implementation of Cordova's Platform API.
+The Platform API defines interfaces for Cordova tooling to be able to create,
+build/compile, run/emulate and clean Cordova projects targeted at a specific
+platform. Core Cordova platforms such as cordova-android and cordova-ios
+implement this API. This API is then used by tools such as cordova-cli and
+cordova-lib when managing platform-specific actions in cross-platform Cordova
+projects.
 
 # Report Issues
 Report them at the [Apache Cordova Issue Tracker](https://issues.apache.org/jira/browse/CB).
 
 # Further Reading
-- [Apache Cordova Documentation](http://docs.cordova.io)
\ No newline at end of file
+- [Apache Cordova Documentation](http://docs.cordova.io)
+- https://github.com/cordova/cordova-discuss/pull/9
+- https://github.com/cordova/cordova-discuss/pull/12


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Document Platform API
> ---------------------
>
>                 Key: CB-11347
>                 URL: https://issues.apache.org/jira/browse/CB-11347
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: cordova-docs, cordova-lib
>            Reporter: Shazron Abdullah
>            Priority: Major
>              Labels: triaged
>
> Right now the Platform API is undocumented. Emerging platforms need to read the source
to find out how it all works.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

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


Mime
View raw message