diff --git a/README.md b/README.md index 0f19607..51c213e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ +# Trinteract + [![License: CERN-OHL-S](https://img.shields.io/badge/Hardware%20License-CERN--OHL--S-blueviolet)](https://opensource.org/licenses/MIT) [![License: MIT](https://img.shields.io/badge/Software%20License-MIT-yellow)](https://opensource.org/licenses/MIT) [![License: CC BY-SA 4.0](https://img.shields.io/badge/Documentation%20License-CC_BY--SA_4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/) -# Trinteract diff --git a/docs/.buildinfo b/docs/.buildinfo index 96ef634..d01cc46 100644 --- a/docs/.buildinfo +++ b/docs/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 867712ae6299a62ff1e5e4e1b8503442 +config: 183e254e428a00b6f95c365dce9902a0 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index 910b902..0b509de 100644 Binary files a/docs/.doctrees/environment.pickle and b/docs/.doctrees/environment.pickle differ diff --git a/docs/_sources/build_your_own/3D Printing.rst.txt b/docs/_sources/build_your_own/3D Printing.rst.txt new file mode 100644 index 0000000..0d1743b --- /dev/null +++ b/docs/_sources/build_your_own/3D Printing.rst.txt @@ -0,0 +1,2 @@ +3D Printing +=========== \ No newline at end of file diff --git a/docs/_sources/build_your_own/overview.rst.txt b/docs/_sources/build_your_own/overview.rst.txt new file mode 100644 index 0000000..0f276ed --- /dev/null +++ b/docs/_sources/build_your_own/overview.rst.txt @@ -0,0 +1,2 @@ +Overview +======== \ No newline at end of file diff --git a/docs/_sources/customization/Pinout.rst.txt b/docs/_sources/customization/Pinout.rst.txt new file mode 100644 index 0000000..ee352d2 --- /dev/null +++ b/docs/_sources/customization/Pinout.rst.txt @@ -0,0 +1,2 @@ +Pinout +====== \ No newline at end of file diff --git a/docs/_sources/development/About.rst.txt b/docs/_sources/development/About.rst.txt new file mode 100644 index 0000000..213ccd0 --- /dev/null +++ b/docs/_sources/development/About.rst.txt @@ -0,0 +1,5 @@ +About +===== + + +testiiing \ No newline at end of file diff --git a/docs/_sources/development/Changelog.rst.txt b/docs/_sources/development/Changelog.rst.txt new file mode 100644 index 0000000..e20de88 --- /dev/null +++ b/docs/_sources/development/Changelog.rst.txt @@ -0,0 +1,7 @@ +hangelog +======== + +Installation +------------ + +I'm testing thissss \ No newline at end of file diff --git a/docs/_sources/development/Contributing.rst.txt b/docs/_sources/development/Contributing.rst.txt new file mode 100644 index 0000000..fbc28d7 --- /dev/null +++ b/docs/_sources/development/Contributing.rst.txt @@ -0,0 +1,6 @@ +Contributing +============ +Installation +------------ + +I'm testing thissss \ No newline at end of file diff --git a/docs/_sources/getting_started/Configuration.rst.txt b/docs/_sources/getting_started/Configuration.rst.txt new file mode 100644 index 0000000..4656901 --- /dev/null +++ b/docs/_sources/getting_started/Configuration.rst.txt @@ -0,0 +1,8 @@ +Configuration +============= + +.. code-block:: c++ + + Joystick.setXAxisRange(-64, 64); + Joystick.setYAxisRange(-64, 64); + Joystick.setZAxisRange(-64, 64); \ No newline at end of file diff --git a/docs/_sources/getting_started/Examples.rst.txt b/docs/_sources/getting_started/Examples.rst.txt new file mode 100644 index 0000000..69a841b --- /dev/null +++ b/docs/_sources/getting_started/Examples.rst.txt @@ -0,0 +1,7 @@ +Examples +======== + +Installation +------------ + +I'm testing thissss \ No newline at end of file diff --git a/docs/_sources/getting_started/Installation.rst.txt b/docs/_sources/getting_started/Installation.rst.txt new file mode 100644 index 0000000..068fa8a --- /dev/null +++ b/docs/_sources/getting_started/Installation.rst.txt @@ -0,0 +1,6 @@ +Interactive Tutorial +==================== + +.. raw:: html + + diff --git a/docs/_sources/getting_started/Quick Start.rst.txt b/docs/_sources/getting_started/Quick Start.rst.txt new file mode 100644 index 0000000..2149906 --- /dev/null +++ b/docs/_sources/getting_started/Quick Start.rst.txt @@ -0,0 +1,43 @@ +Quick Start +=========== + +To get started with **trinteract**, connect an **3.3v** arduino pro micro to the board as shown in the picture along with the 3D printed top. If you're building your own kit head over to the :doc:`🛠️ Build Your Own ` section. + +.. admonition:: Important + :class: attention + + trinteract is only compatible with 3.3 volts, any higher voltage could fry the sensor + +.. image:: Figure1.png + :align: center + +.. It can track movement in all 3 axes, and you can customize it further by following the +.. instructions on this website. + + + .. note:: +.. The zxyKit is pre-configured to work with **Blender** out of the box, If you want to use it with other software +.. visit the :doc:`Configuration` page. + +.. :abbr:`HTML (Hyper Text Markup Language)` + +.. Next, launch the interactive tutorial on figma following the link below. + +.. - To get started: + +.. - Attach the purple board to the Arduino as shown in the picture. +.. - Connect the board to your computer using the micro usb cable. +.. - Launch Blender and go into fly mode from the ``View ‣ Navigation`` menu. +.. Or using the ``Shift`` + ``accent grave`` shortcut. +On Windows, Your computer will recognize trinteract as a game controller. To check if it's recognized go to: +``Control Panel`` → ``Devices and Printers`` → ``Set up USB game controllers`` and click ``Properties`` + +.. image:: Figure2.png + :width: 45% + +.. image:: Figure3.gif + :width: 45% + +.. note:: + If trinteract isn't recognized on your computer you can visit the Troubleshooting guide here + diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt new file mode 100644 index 0000000..330dde0 --- /dev/null +++ b/docs/_sources/index.rst.txt @@ -0,0 +1,53 @@ +.. zxyKit documentation master file, created by + sphinx-quickstart on Thu Apr 20 13:37:44 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to zxyKit's documentation! +=================================== +test + +.. note:: + + This project is under active developmenttttttgggggg + +Contents +-------- +.. toctree:: + :maxdepth: 2 + :caption: ✨ Getting Started + + getting_started/Quick Start + getting_started/Installation + getting_started/Configuration + getting_started/Examples + +.. toctree:: + :maxdepth: 2 + :caption: 🎨 Customization + + customization/Pinout + +.. toctree:: + :maxdepth: 2 + :caption: 🛠️ Build Your Own + + build_your_own/overview + build_your_own/3D Printing + +.. toctree:: + :maxdepth: 2 + :caption: 📖 Development + + development/About + development/Contributing + development/Changelog + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/build_your_own/3D Printing.html b/docs/build_your_own/3D Printing.html index b192332..4795843 100644 --- a/docs/build_your_own/3D Printing.html +++ b/docs/build_your_own/3D Printing.html @@ -3,7 +3,7 @@ - +
@@ -14,7 +14,7 @@ @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - - - - @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - - - - @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - - - - @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - - - - @@ -53,7 +53,7 @@ - + @@ -120,8 +120,6 @@ - - @@ -197,6 +195,70 @@ + + + + + + + - - - - - @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - - - - @@ -51,7 +51,7 @@ - + @@ -118,8 +118,6 @@ - - @@ -193,18 +191,49 @@ - + + + +Open issue + + + + + @@ -54,7 +54,7 @@ - + @@ -121,8 +121,6 @@ - - @@ -198,6 +196,70 @@ + + + + + + + - - -