From 3c64d4da2a929d49e01cfc9313efd7928535bc7b Mon Sep 17 00:00:00 2001 From: Kasen IO Date: Mon, 13 Apr 2020 21:19:09 -0400 Subject: [PATCH] First pass at correcting wording. --- web/index.html | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/web/index.html b/web/index.html index 62d44cc..5f7a94c 100644 --- a/web/index.html +++ b/web/index.html @@ -16,40 +16,39 @@
-

"Project Athena" Applications Repository

-

This repository stores the optional tablet's applications and functionalities provided by the contributions of the community members. - If you have created an Application or functionality and want to offer it to the community, this is where you can do it.

+

Vircadia Community Applications Repository

+

This repository stores optional tablet applications and functionalities provided by the contributions of the community members. + If you have created an Application or functionality script and want to offer it to the community, this is where you can do it.

Before going further:

    -
  1. If your application/functionality is a core feature that you think that required being delivered out-of-the-box with "Project Athena", you must instead consider making your contribution directly in the "Project Athena" code line. See instead the Project Athena repository and contact their maintainers.

    2. -
  2. If your application/functionality has any dependency with an external server or services. (If it has to deal in any ways with other servers than a Project Athena Domain or Metaverse API) This repository is not where you should publish your application. It will have to be published from a different source like the Marketplace (when it will exist) or another web site.
    3. +
  3. If your application/functionality is a core feature that you think should be delivered out-of-the-box with Vircadia, you must instead consider making your contribution directly in the Vircadia code repository. See instead the Vircadia repository and contact the core team.

    4. +
  4. If your application/functionality has a dependency with on an external server or services (if it has to deal in any ways with other servers than a Vircadia Domain or Metaverse API), then this repository is not where you should publish your application. It will have to be published to a different source like the Marketplace (when it is created) or another web site.

Conditions for acceptance:

    -
  1. You must include in your script a license reference making your script fully open source:
    +
  2. You must include a license reference in your files to make your script fully open source:
    // Distributed under the Apache License, Version 2.0.
    // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html

  3. Avoid spaces and special characters in your folders and file names.
    (Stay with: "a-z", "A-Z", "0-9", "-", "_", ".")

    4. -
  4. Add your application/functionality in a folder under the "applications" directory.
    +
  5. Add your application/functionality in a folder under the "applications" directory.
    (Your main js file and your icon must be directly in that folder)

    6. -
  6. You must add your application/functionality to the "metadata.js" file (in the "applications" directory) by generating a new one using this tool: Metadata Generator
    7. +
  7. You must add your application/functionality to the "metadata.js" file (in the "applications" directory) by generating a new one using this tool: Metadata Generator

Submit a "Pull Request" to add your "application folder" and the new "metadata.js" file.
- (If you are not comfortable with those procedures, contact Keb Helion on "Project Athena" Discord.)

+ (If you are not comfortable with these procedures, contact Keb Helion on Vircadia Discord.)


Guidelines for the code reviewer:

    -
  1. Test the applications in the "Project Athena".

    2. -
  2. Make sure that the JSON and Javascript contained in "metadata.js" are valid before accepting the commit. !!! This will be directly in production once committed. !!!

    3. -
  3. Test the "More..." application in the "Project Athena" after having done: "Edit > Reload Content (Clears all caches)", and at least 5 minutes after the commit.
    4. +
  4. Test the applications in Vircadia.

    5. +
  5. Make sure that the JSON and Javascript contained in "metadata.js" are valid before accepting the pull request! This will affect the production "More" application immediately for all users.

    6. +
  6. Test the "More..." application in Vircadia.
-