Netsyms/Mods-for-HESK-Netsyms
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README.md

Browse Source 
Added notes for versioning, browser compatibility, and for language translations
This commit is contained in:
Mike Koch 2014-03-24 19:51:02 -04:00
parent 066a80eff4
commit 127ee33048
1 changed files with 31 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,7 +1,6 @@
[![Analytics](https://ga-beacon.appspot.com/UA-49251479-1/hesk/README)](https://github.com/mkoch227/Hesk) [![Analytics](https://ga-beacon.appspot.com/UA-49251479-1/hesk/README)](https://github.com/mkoch227/Hesk)
<h2>hesk-ui</h2> <h2>HESK UI</h2>
This branch contains all files modified from the base version of HESK to become HESK UI, a clean user interface for HESK v2.5.3 This branch contains all files modified from the base version of HESK to become HESK UI, a clean user interface for HESK v2.5.3
@ -24,3 +23,33 @@ You can download this tweak via two ways:
<li>Upload the resulting folder to your webserver.</li> <li>Upload the resulting folder to your webserver.</li>
</ol> </ol>
<p>Please consult the official HESK Documentation on how to install HESK, as it is the same for both HESK and HESK UI.</p> <p>Please consult the official HESK Documentation on how to install HESK, as it is the same for both HESK and HESK UI.</p>
<h2>Languages</h2>
<p>As of current, only English is a supported language, as there have been several language items that have been edited/created. If you want to translate HESK UI to your own language, it is recommended to download the original HESK language file for your language, and then add/edit the lines listed under <code>//Added or modified in HESK UI</code> for your language.</p>
<p>If you create a translation for HESK UI, please submit it via a pull request or via the PHP Junkyards forum, where it will be committed to this branch.</p>
<h2>Browser Compability</h2>
<p>This list may be incomplete. Please leave a note on the PHP Junkyard forums for additional browser compatibility information.
<ul>
<li><strong>Google Chrome 33+: </strong> Compatible</li>
<li><strong>Mozilla Firefox 28+:</strong> Compatible</li>
<li><strong>Internet Explorer 6/7:</strong> <em>NOT</em> Compatible</li>
<li><strong>Internet Explorer 8:</strong> Partial Compatibility</li>
<li><strong>Internet Explorer 9:</strong> Compatible</li>
</ul>
<p>There are no intentions of making HESK UI compatible with Internet Explorer 6 or 7, or any browser that is 2 or more major revisions older than its latest version.</p>
<h2>Versioning</h2>
<p>HESK UI will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:</p>
<code>&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;</code>
<p>And constructed with the following guidelines:</p>
<ul>
<li>Breaking backward compatibility bumps the major (and resets the minor and patch)</li>
<li>New additions, including new minor features, without breaking backward compatibility bumps the minor (and resets the patch)</li>
<li>Bug fixes and misc minor changes bumps the patch</li>
</ul>
For more information on SemVer, please visit http://semver.org.