cake
/
cahute
mirror of https://gitlab.com/cahuteproject/cahute.git
1
0
Fork 0
Code

docs: revamp docs index

This commit is contained in:
Thomas Touhey 2024-04-22 15:20:21 +02:00
parent 97eb14fb2d
commit 3718347d78
7 changed files with 110 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/_static/custom.css vendored
View File

@ -11,6 +11,19 @@ h1 img, h2 img, p img {
text-align: center;
}
#cahute-version .toctree-wrapper > ul {
display: flex;
list-style-type: none;
flex-wrap: wrap;
padding-left: 0;
gap: .5em 1em;
}
#cahute-version .toctree-wrapper > ul > li {
display: inline-block;
flex: 1 0 20em;
}
.bottom-of-page .icons svg,
.bottom-of-page .icons img {
width: auto;

53
docs/acknowledgements.rst
View File

@ -1,53 +0,0 @@
Acknowledgements
================
There have been many projects over the years about reversing and
reimplementing CASIO's shenannigans for using their calculators from
alternative OSes, or simply for fun or out of curiosity. Cahute couldn't
have been made without their research, implementations and in some cases,
documentation. This page is a little tribute to these works.
* Thanks to Tom Wheeley and Tom Lynn for their work on CaS and Caspro_
and the `Casio Graphical Calculator Encyclopaedia`_.
* Thanks to the (now defunct) Graph100.com wiki, `saved here
<Graph100.com Wiki_>`_ for historical purposes.
* Thanks to the team behind Casetta_ for their documentation on legacy
protocols and file formats, which helped me navigate the subtleties more
easily.
* Thanks to `Simon Lothar`_ and Andreas Bertheussen for their work on
Protocol 7.00 and derivatives through fxReverse_ and xfer9860, and to
Teamfx_ for `their additions <Teamfx additions_>`_.
* Thanks to the Cemetech community for their `Prizm Wiki`_, especially
gbl08ma, BrandonWilson and amazonka.
* Thanks to Nessotrin_ for their work on UsbConnector_, which prompted me
to work on a better version in the first place.
There are obviously plenty more people working on other connected aspects
(hardware, low-level system stuff), administering or moderating forums and
websites, maintaining communication with CASIO and other partners.
Quoting you all would take a substantial time, and I'd likely miss quite a lot
of you, but thank you all for your efforts!
.. _Simon Lothar:
https://www.casiopeia.net/forum/memberlist.php?mode=viewprofile&u=10405
.. _Teamfx:
https://www.casiopeia.net/forum/memberlist.php?mode=viewprofile&u=10504&sid=b1f4fb842b29e6f686d832a7e1117789
.. _Nessotrin:
https://www.planet-casio.com/Fr/compte/voir_profil.php?membre=nessotrin
.. _Casio Graphical Calculator Encyclopaedia:
https://serval.mythic-beasts.com/~tom/calcs/calcs/encyc/
.. _Graph100.com Wiki:
https://bible.planet-casio.com/cakeisalie5/websaves/graph100.com/
.. _fxReverse:
https://bible.planet-casio.com/simlo/fxreverse/fxReverse2.pdf
.. _Teamfx additions: https://bible.planet-casio.com/teamfx/
.. _Prizm Wiki: https://prizm.cemetech.net/
.. _UsbConnector:
https://www.planet-casio.com/Fr/forums/topic13656-1-usbconnector
-remplacement-de-fa124-multi-os.html
.. _Casetta: https://casetta.tuxfamily.org/
.. _Caspro:
https://web.archive.org/web/20160504230033/
http://www.spiderpixel.co.uk:80/caspro/

2
docs/cli-guides.rst
View File

@ -5,7 +5,7 @@ These sections describe specific problems that you may want to solve using
the command-line (CLI) utilities provided by Cahute.
.. toctree::
:maxdepth: 1
:maxdepth: 2
cli-guides/get-info
cli-guides/send-file

2
docs/cli.rst
View File

@ -5,7 +5,7 @@ This section presents the command line reference, i.e. all options and
syntaxes support by Cahute's command-line utilities.
.. toctree::
:maxdepth: 1
:maxdepth: 2
cli/cas
cli/p7

2
docs/developer-guides.rst
View File

@ -1,4 +1,4 @@
Developer Guides
Developer guides
================
These sections describe specific problems that you may want to solve using

2
docs/headers.rst
View File

@ -4,6 +4,6 @@ Header reference
This section presents the code reference, by header.
.. toctree::
:maxdepth: 1
:maxdepth: 2
headers/cahute

95
docs/index.rst
View File

@ -20,19 +20,86 @@ version 2.1 as distributed by the CEA, CNRS and Inria on
This documentation is organized using `Diátaxis`_' structure.
Acknowledgements
----------------
There have been many projects over the years about reversing and
reimplementing CASIO's shenannigans for using their calculators from
alternative OSes, or simply for fun or out of curiosity. Cahute couldn't
have been made without their research, implementations and in some cases,
documentation. This page is a little tribute to these works.
* Thanks to Tom Wheeley and Tom Lynn for their work on CaS and Caspro_
and the `Casio Graphical Calculator Encyclopaedia`_.
* Thanks to the (now defunct) Graph100.com wiki, `saved here
<Graph100.com Wiki_>`_ for historical purposes.
* Thanks to the team behind Casetta_ for their documentation on legacy
protocols and file formats, which helped me navigate the subtleties more
easily.
* Thanks to `Simon Lothar`_ and Andreas Bertheussen for their work on
Protocol 7.00 and derivatives through fxReverse_ and xfer9860, and to
Teamfx_ for `their additions <Teamfx additions_>`_.
* Thanks to the Cemetech community for their `Prizm Wiki`_, especially
gbl08ma, BrandonWilson and amazonka.
* Thanks to Nessotrin_ for their work on UsbConnector_, which prompted me
to work on a better version in the first place.
There are obviously plenty more people working on other connected aspects
(hardware, low-level system stuff), administering or moderating forums and
websites, maintaining communication with CASIO and other partners.
Quoting you all would take a substantial time, and I'd likely miss quite a lot
of you, but thank you all for your efforts!
How-to guides
-------------
These sections provide guides, i.e. recipes, targeted towards various actors.
They guide you through the steps involved in addressing key problems
and use-cases.
.. toctree::
:maxdepth: 3
acknowledgements
guides
cli-guides
developer-guides
Discussion topics
-----------------
These sections discuss key topics and concepts at a fairly high level,
and provide useful background information and explanation.
.. toctree::
:maxdepth: 3
topics
internals
project
References
----------
These sections provide technical reference for APIs and other aspects of
Cahute's machinery. They go into detail, and therefore, assume you have a
basic understanding of key concepts.
.. toctree::
:maxdepth: 3
cli
headers
Project management
------------------
These sections describe how the project is managed, and what works it
is based on.
.. toctree::
:maxdepth: 3
project
.. _Cahute on Gitlab: https://gitlab.com/cahuteproject/cahute
.. _Thomas Touhey: https://thomas.touhey.fr/
.. _CeCILL: http://www.cecill.info/licences.en.html
@ -45,3 +112,27 @@ This documentation is organized using `Diátaxis`_' structure.
.. _UCF topic:
https://community.casiocalc.org/topic/
8214-cahute-a-toolset-for-protocols-and-file-formats/
.. _Simon Lothar:
https://www.casiopeia.net/forum/memberlist.php?mode=viewprofile&u=10405
.. _Teamfx:
https://www.casiopeia.net/forum/memberlist.php?mode=viewprofile&u=10504&sid=b1f4fb842b29e6f686d832a7e1117789
.. _Nessotrin:
https://www.planet-casio.com/Fr/compte/voir_profil.php?membre=nessotrin
.. _Casio Graphical Calculator Encyclopaedia:
https://serval.mythic-beasts.com/~tom/calcs/calcs/encyc/
.. _Graph100.com Wiki:
https://bible.planet-casio.com/cakeisalie5/websaves/graph100.com/
.. _fxReverse:
https://bible.planet-casio.com/simlo/fxreverse/fxReverse2.pdf
.. _Teamfx additions: https://bible.planet-casio.com/teamfx/
.. _Prizm Wiki: https://prizm.cemetech.net/
.. _UsbConnector:
https://www.planet-casio.com/Fr/forums/topic13656-1-usbconnector
-remplacement-de-fa124-multi-os.html
.. _Casetta: https://casetta.tuxfamily.org/
.. _Caspro:
https://web.archive.org/web/20160504230033/
http://www.spiderpixel.co.uk:80/caspro/