You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ja...@apache.org on 2019/05/03 18:01:24 UTC
[cordova-test-platform] 05/07: restructure headlines explain actual
usage
This is an automated email from the ASF dual-hosted git repository.
janpio pushed a commit to branch janpio-platformrequirements_fixes
in repository https://gitbox.apache.org/repos/asf/cordova-test-platform.git
commit 00aaf3fa2d2f98be5890adefb8adb12a0e44084b
Author: Jan Piotrowski <pi...@gmail.com>
AuthorDate: Fri May 3 19:39:23 2019 +0200
restructure headlines
explain actual usage
---
README.md | 28 ++++++++++++++++------------
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/README.md b/README.md
index d361b39..6d180c4 100644
--- a/README.md
+++ b/README.md
@@ -26,19 +26,23 @@ 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)
+## Background
-# 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`](https://github.com/apache/cordova-android) and [`cordova-ios`](https://github.com/apache/cordova-ios) implement this API. This API is then used by tools such as [`cordova-cli`](https://github.com [...]
-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.
+You can read more about the requirements in [PlatformRequirements.md](PlatformRequirements.md) as well.
+
+## Usage
+
+To add this platform to a test project using Cordova CLI run:
+
+```
+cordova platform add https://github.com/apache/cordova-test-platform
+```
+
+## Further Reading
-# Further Reading
- [Apache Cordova Documentation](http://docs.cordova.io)
-- https://github.com/cordova/cordova-discuss/pull/9
-- https://github.com/cordova/cordova-discuss/pull/12
+- Historical
+ - https://github.com/cordova/cordova-discuss/pull/9
+ - https://github.com/cordova/cordova-discuss/pull/12
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org