Update documentation.

This commit is contained in:
Jordan Bancino 2022-08-09 13:22:33 -04:00
parent 9d496c29ac
commit 0a101f0853

View file

@ -306,10 +306,10 @@ can get involved.
<li><s>Write a release script</s></li> <li><s>Write a release script</s></li>
<li><s>UTF-8 encoder</s></li> <li><s>UTF-8 encoder</s></li>
<li> <li>
Implement a JSON library using the hash map and array <s>Implement a JSON library using the hash map and array</s>
<ul> <ul>
<li><s>Basic encoding from HashMap/Array/strings, etc.</s></li> <li><s>Basic encoding from HashMap/Array/strings, etc.</s></li>
<li>Basic decoding to HashMap/Array/strings, etc.</li> <li><s>Basic decoding to HashMap/Array/strings, etc.</s></li>
<li><s>Proper string encoding</s></li> <li><s>Proper string encoding</s></li>
<li><s>Proper string decoding</s></li> <li><s>Proper string decoding</s></li>
<li> <li>
@ -323,7 +323,7 @@ Implement a JSON library using the hash map and array
</li> </li>
</ul> </ul>
</li> </li>
<li><s>Write a function that gets the current Unix timestamp in milliseconds.</s></code> <li><s>Write a function that gets the current Unix timestamp in milliseconds.</s></code>
<li><s>Figure out how to w</s>Write unit tests for array/hashmap/etc</li> <li><s>Figure out how to w</s>Write unit tests for array/hashmap/etc</li>
<li>Parse the <b>Telodendria</b> config file</li> <li>Parse the <b>Telodendria</b> config file</li>
<li>Add <s>license/</s>documentation comments to all source files</li> <li>Add <s>license/</s>documentation comments to all source files</li>
@ -386,11 +386,11 @@ on my list for that:
<code>anoncvs</code> account is just <code>anoncvs</code>.</s></li> <code>anoncvs</code> account is just <code>anoncvs</code>.</s></li>
<li><s>Add Contributors list</s></li> <li><s>Add Contributors list</s></li>
<li><s>Add list of <code>make.sh</code> recipes, and what they do</s></li> <li><s>Add list of <code>make.sh</code> recipes, and what they do</s></li>
<li>Lighthouse Score <li>Improve Google Lighthouse score
<ul> <ul>
<li>Image elements do not have explicit width and height</li> <li>Image elements do not have explicit width and height</li>
<li>Background and foreground colors do not have a sufficient contrast ratio. (<code>msg-error</code> div)</li> <li>Background and foreground colors do not have a sufficient contrast ratio. (<code>msg-error</code> div)</li>
<li>Lists do not contain only <code>li</code> elements.</li> <li><s>Lists do not contain only <code>li</code> elements.</s></li>
</ul> </ul>
</li> </li>
<li>Add other message <code>div</code>s for notes and warnings.</li> <li>Add other message <code>div</code>s for notes and warnings.</li>
@ -905,6 +905,7 @@ notice and permission notice be included in <i>all</i>
portions&mdash;regardless of size&mdash;of the software by omitting portions&mdash;regardless of size&mdash;of the software by omitting
the word <i>substantial</i>. the word <i>substantial</i>.
</li> </li>
</ul>
<p> <p>
The documentation for <b>Telodendria</b> is also licensed under the The documentation for <b>Telodendria</b> is also licensed under the
modified MIT license that lives in <code>src/header.txt</code>. Whether modified MIT license that lives in <code>src/header.txt</code>. Whether
@ -919,7 +920,6 @@ official <b>Telodendria</b> project, and may only appear in official
must be removed from the project and optionally replaced by a different must be removed from the project and optionally replaced by a different
one. The logo may not be modified in any way or for any purpose. one. The logo may not be modified in any way or for any purpose.
</p> </p>
</ul>
<h2 id="contributors">Contributors</h2> <h2 id="contributors">Contributors</h2>
<p> <p>
<b>Telodendria</b> would not be possible without the support of the <b>Telodendria</b> would not be possible without the support of the