Skip to content

Commit

Permalink
Documentation structure update
Browse files Browse the repository at this point in the history
* Add build instructions page
* Update docs/Building.rst
* fixes document width
* manually converted md to rst
* headings are now more standardized

Issues:
#21 #25 

Co-Authored-By: Andrew Steele <ahsteele@users.noreply.github.com>

* Update docs/Stringification.rst

Co-Authored-By: Andrew Steele <ahsteele@users.noreply.github.com>

* Update docs/Unsigned-Arithmetic-Operations.rst

Co-Authored-By: Andrew Steele <ahsteele@users.noreply.github.com>

* Using same value for big and little endian description

apparently I did a bad, fixed the Decimal to Hex conversion of 8675309
Added latex notation to doc
  • Loading branch information
rheone authored and ahsteele committed Nov 8, 2019
1 parent 87fef66 commit b413f89
Show file tree
Hide file tree
Showing 28 changed files with 1,800 additions and 1,403 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\docs"
}
22 changes: 0 additions & 22 deletions docs/Acknowledgements.md

This file was deleted.

28 changes: 28 additions & 0 deletions docs/Acknowledgements.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

Acknowledgements
################

Citations
*********

Wikipedia on Endianness
=======================

Wikipedia contributors. (2019, October 10). Endianness. In Wikipedia, The Free Encyclopedia. Retrieved 18:31, October 13, 2019, from `https://en.wikipedia.org/w/index.php?title=Endianness&oldid=920566520 <https://en.wikipedia.org/w/index.php?title=Endianness&oldid=920566520>`_.

"Simply Explained" comic
========================

`"Simply Explained" comic <http://geek-and-poke.com/geekandpoke/2011/9/7/simply-explained.html>`_

Widder, O. (2011, September 7). Simply Explained. Retrieved October 13, 2019, from `<http://geek-and-poke.com/geekandpoke/2011/9/7/simply-explained.html <http://geek-and-poke.com/geekandpoke/2011/9/7/simply-explained.html>`_.

Gulliver logo
=============

`Title page of first edition of Gulliver's Travels by Jonathan Swift. <https://commons.wikimedia.org/wiki/File:Gullivers_travels.jpg>`_

This work is in the public domain in its country of origin and other countries and areas where the copyright term is the author's life plus 70 years or fewer.

U.S. work public domain in the U.S. for unspecified reason but presumably because it was published in the U.S. before 1924.
This work has been identified as being free of known restrictions under copyright law, including all related and neighboring rights.
Loading

0 comments on commit b413f89

Please sign in to comment.