Improves Writing and Removes References to "Functionalities".

I am not sure if there is a concept of "functionalities" that is different from applications but, since I have not happened across that information and since this is the "community-apps" repo, I have taken the liberty of removing those references. Feel free to add them back in if they do refer to something other than applications, but in that case it might be good to (1) add some documentation to clarify what "functionalities" are and (2) rename this repo to something that does not specify "apps".
This commit is contained in:
Penguin-Guru 2021-10-08 10:52:44 -07:00 committed by GitHub
parent 5ee48797ec
commit ace36b37eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -17,12 +17,12 @@
<div id="wrapper">
<div id="content">
<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>
<p>This repository stores optional <b>tablet applications</b> and <b>functionalities</b> provided by the contributions of community members who are not core developers of Vircadia.
If you have created a Vircadia application 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 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>
<li>If your application is a <b>core feature</b> that you think should be <b>installed by default for all Vircadia users</b>, you should instead consider making your contribution directly in the <b>Vircadia</b> code repository. See 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 is <b>dependent on an external server or service</b> (if it has to deal in any way with servers other 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>
@ -32,10 +32,10 @@
</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/kasenvr/community-apps/tree/master/applications'>applications</a></b>" directory.<br>
<li>Add your application 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/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>
<li>You must add your application 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>
@ -52,4 +52,4 @@
</div>
</div>
</body>
</html>
</html>