Mirrors/community-apps
3
0
Fork 0
mirror of https://github.com/overte-org/community-apps.git synced 2025-04-05 21:22:00 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

First pass at correcting wording.

Browse source
This commit is contained in:
Kasen IO 2020-04-13 21:19:09 -04:00
parent a1a6258614
commit 3c64d4da2a
1 changed files with 12 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
web/index.html
View file

@ -16,40 +16,39 @@
<body>
<div id="wrapper">
<div id="content">
<h1>"Project Athena" Applications Repository</h1>
<p>This repository stores the optional <b>tablet's applications</b> and <b>functionalities</b> 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.</p>
<h1>Vircadia Community Applications Repository</h1>
<p>This repository stores optional <b>tablet applications</b> and <b>functionalities</b> 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.</p>
<h2>Before going further:</h2><ol>
<li>If your application/functionality is a <b>core feature</b> that you think that <b>required being delivered out-of-the-box with "Project Athena"</b>, you must instead consider making your contribution directly in the "<b>Project Athena</b>" code line. See instead the <b><a href = 'https://github.com/kasenvr/project-athena'>Project Athena</a></b> repository and contact their maintainers.</li><br>
<li>If your application/functionality has any <b>dependency with an external server or services</b>. <i>(If it has to deal in any ways with other servers than a Project Athena Domain or Metaverse API)</i> This repository is not where you should publish your application. It will have to be published from a different source like the <b>Marketplace</b> <i>(when it will exist)</i> or another web site.</li>
<li>If your application/functionality is a <b>core feature</b> that you think should be <b>delivered out-of-the-box with Vircadia</b>, you must instead consider making your contribution directly in the <b>Vircadia</b> code repository. See instead the <b><a href = 'https://github.com/kasenvr/project-athena'>Vircadia</a></b> repository and contact the core team.</li><br>
<li>If your application/functionality has a <b>dependency with on an external server or services</b> (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 <b>Marketplace</b> (when it is created) or another web site.</li>
</ol>
<br>
<h2>Conditions for acceptance:</h2><ol>
<li>You must include in your script a <b>license</b> reference making your script fully open source:<br>
<li>You must include a <b>license</b> reference in your files to make your script fully open source:<br>
<font class = 'greencommented' >// Distributed under the Apache License, Version 2.0.<br>
// See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html</font><br>
</li><br>
<li>Avoid <b>spaces</b> and <b>special characters</b> in your <b>folders</b> and <b>file names</b>.<br><font class = 'greencommented' >(Stay with: "<b>a-z</b>", "<b>A-Z</b>", "<b>0-9</b>", "<b>-</b>", "<b>_</b>", "<b>.</b>")</font></li><br>
<li>Add your application/functionality in a <b>folder</b> under the "<b><a href = 'https://github.com/KebHelion/apps_repository/tree/master/applications'>applications</a></b>" directory.<br>
<li>Add your application/functionality in a <b>folder</b> under the "<b><a href = 'https://github.com/kasenvr/community-apps/tree/master/applications'>applications</a></b>" directory.<br>
<font class = 'greencommented' >(Your main js file and your icon must be directly in that folder)</font></li><br>
<li>You must add your application/functionality to the "<b>metadata.js</b>" file (in the "<b><a href = 'https://github.com/KebHelion/apps_repository/tree/master/applications'>applications</a></b>" directory) by generating a new one using this tool: <b><a href='metadata_js_generator.html'>Metadata Generator</a></b></li>
<li>You must add your application/functionality to the "<b>metadata.js</b>" file (in the "<b><a href = 'https://github.com/kasenvr/community-apps/tree/master/applications'>applications</a></b>" directory) by generating a new one using this tool: <b><a href='metadata_js_generator.html'>Metadata Generator</a></b></li>
</ol>
<p><b>Submit a "<u>Pull Request</u>" to add your "<u>application folder</u>" and the new "<u>metadata.js</u>" file.</b><br>
<font class = 'greencommented' >(If you are not comfortable with those procedures, contact <b>Keb Helion</b> on "Project Athena" Discord.)</font></p>
<font class = 'greencommented' >(If you are not comfortable with these procedures, contact <b>Keb Helion</b> on Vircadia Discord.)</font></p>
<br>
<h2>Guidelines for the code reviewer:</h2><ol>
<li>Test the applications in the "<b>Project Athena</b>".</li><br>
<li>Make sure that the <b>JSON</b> and <b>Javascript</b> contained in "<b>metadata.js</b>" are <u>valid</u> before accepting the commit. <b>!!! This will be directly in production once committed. !!!</b></li><br>
<li>Test the "<b>More...</b>" application in the "<b>Project Athena</b>" after having done: "<b><i>Edit > Reload Content (Clears all caches)</i></b>", and at least <u>5 minutes</u> after the commit.</li>
<li>Test the applications in <b>Vircadia</b>.</li><br>
<li>Make sure that the <b>JSON</b> and <b>Javascript</b> contained in "<b>metadata.js</b>" are <u>valid</u> before accepting the pull request!<b> This will affect the production "More" application immediately for all users.</b></li><br>
<li>Test the "<b>More...</b>" application in <b>Vircadia</b>.</li>
</ol>
</p>
</div>
</div>
</body>