FunctionProject/documentation/index.html

75 lines
5.4 KiB
HTML
Raw Normal View History

2019-11-11 17:55:52 +01:00
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>FunctionProject Documentation</title>
2019-11-11 17:55:52 +01:00
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">FunctionProject</h1>
<section>
<article>
<p><img src="https://cloud.divlo.fr/public_files/others/Trash/under_dev.svg" alt="Badge Status"></p>
<p><a href="https://divlo.fr/">À propos de Divlo</a> | <a href="https://www.youtube.com/c/Divlo">Youtube</a> | <a href="https://www.twitch.tv/divlo">Twitch</a> | <a href="https://twitter.com/Divlo_FR">Twitter</a> | <a href="mailto:contact@divlo.fr">E-mail</a></p>
<h2>À propos de FunctionProject</h2>
<p><a href="https://function.divlo.fr/">FunctionProject</a> est un projet créé par <a href="https://divlo.fr/">Divlo</a> qui a pour but de rassembler plein de mini-programmes permettant de faire plusieurs choses comme <strong>savoir la météo</strong>, générer un <strong>nombre aléatoire</strong>, etc.</p>
<p>Le projet est disponible sur <a href="https://function.divlo.fr/">function.divlo.fr</a>.</p>
<p><a href="https://function.divlo.fr/"><img src="../img/FunctionProject.png" alt="FunctionProject"></a></p>
<h2>Installation</h2>
<p><strong>Note :</strong> Vous aurez besoin dun serveur Apache pour utiliser PHP (exemple: <a href="https://www.apachefriends.org">XAMPP</a>).</p>
<p>Cloner le dépôt en utilisant git :</p>
<pre class="prettyprint source lang-text"><code>git clone https://github.com/Divlo/FunctionProject
</code></pre>
<p>Puis créer un nouveau fichier dans <code>/php</code> du nom de <code>keyVariable.php</code>, puis vous mettrez ce code à l'intérieur, il faudra modifier la valeur de la variable '$apiWeather' par votre clé d'api de <a href="https://openweathermap.org/">openweathermap.org</a>.</p>
<pre class="prettyprint source lang-php"><code>&lt;?php
$apiWeather = 'votre clé api pour openweathermap.org';
</code></pre>
<p>Enjoy! =D</p>
<h2>Librairies</h2>
<ul>
<li><a href="https://fontawesome.com/">Fontawesome</a></li>
<li><a href="https://getbootstrap.com/">Bootstrap</a></li>
<li><a href="https://jquery.com/">jQuery</a></li>
<li><a href="https://jqueryui.com/">jQuery UI</a></li>
<li><a href="https://momentjs.com/">Moment.js</a></li>
</ul>
<h2>Documentation</h2>
<p>La documentation est disponible sur <a href="https://function.divlo.fr/documentation">function.divlo.fr/documentation</a>.
Dans la documentation, il y a la toutes les fonctions, ce qu'elles return, etc.</p>
2019-11-11 17:55:52 +01:00
<h2>Licence</h2>
<p>Ce projet est sous licence MIT - voir le fichier <a href="./LICENSE">LICENSE</a> pour plus de détails.</p></article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#armstrongNumber">armstrongNumber</a></li><li><a href="global.html#binaryToDecimal">binaryToDecimal</a></li><li><a href="global.html#binaryToHexadecimal">binaryToHexadecimal</a></li><li><a href="global.html#binaryToText">binaryToText</a></li><li><a href="global.html#calculateAge">calculateAge</a></li><li><a href="global.html#capitalize">capitalize</a></li><li><a href="global.html#convertArabicToRoman">convertArabicToRoman</a></li><li><a href="global.html#convertCurrency">convertCurrency</a></li><li><a href="global.html#convertDistance">convertDistance</a></li><li><a href="global.html#convertRomanToArabic">convertRomanToArabic</a></li><li><a href="global.html#convertTemperature">convertTemperature</a></li><li><a href="global.html#createSessionCookie">createSessionCookie</a></li><li><a href="global.html#dateTimeUTC">dateTimeUTC</a></li><li><a href="global.html#decimalToBinary">decimalToBinary</a></li><li><a href="global.html#decimalToHexadecimal">decimalToHexadecimal</a></li><li><a href="global.html#filterStudents">filterStudents</a></li><li><a href="global.html#formatNumberResult">formatNumberResult</a></li><li><a href="global.html#getRandomQuote">getRandomQuote</a></li><li><a href="global.html#hexadecimalToBinary">hexadecimalToBinary</a></li><li><a href="global.html#hexadecimalToDecimal">hexadecimalToDecimal</a></li><li><a href="global.html#hexadecimalToText">hexadecimalToText</a></li><li><a href="global.html#isEmptyValue">isEmptyValue</a></li><li><a href="global.html#isFloat">isFloat</a></li><li><a href="global.html#isValidDate">isValidDate</a></li><li><a href="global.html#numberUnicodeToText">numberUnicodeToText</a></li><li><a href="global.html#randomNumber">randomNumber</a></li><li><a href="global.html#realDateTime">realDateTime</a></li><li><a href="global.html#showDateTime">showDateTime</a></li><li><a href="global.html#stringPermutations">stringPermutations</a></li><li><a href="global.html#textToBinary">textToBinary</a></li><li><a href="global.html#textToHexadecimal">textToHexadecimal</a></li><li><a href="global.html#textToNumberUnicode">textToNumberUnicode</a></li><li><a href="global.html#weatherRequest">weatherRequest</a></li></ul>
2019-11-11 17:55:52 +01:00
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Sat Nov 16 2019 10:11:50 GMT+0100 (GMT+01:00)
2019-11-11 17:55:52 +01:00
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>