New document agent

sunfounder · Jul 28, 2021 · cd05ffd · cd05ffd
1 parent 121f446
commit cd05ffd
Show file tree

Hide file tree

Showing 49 changed files with 264 additions and 11 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "restructuredtext.confPath": "${workspaceFolder}\\docs\\source"
+}
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
@@ -0,0 +1,23 @@
+FAQ 
+=============
+
+
+1. If you run the code without opening SunFounderCreateAgent, 
+a connection failure prompt will pop up. After reopening SunFounderCreateAgent, 
+click \"Try again\" to reconnect.
+
+.. image:: media/image39.png
+    :align: center
+
+2. ReadTheDoc currently does not support Safari and Internet Explorer browsers. 
+Support Chrome, Firefox and other browsers.
+
+3. If the installation fails during the installation process, 
+please open the Raspberry Pi Terminal and run the code ``sudo apt update``, after success, 
+double-click SunFounder-Create-Agent-linux-v1.0.0.deb to install.
+
+.. image:: media/image29.png
+    :align: center
+
+.. image:: media/image30.png
+    :align: center
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,18 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to sunfounder-create-agent's documentation!
+SunfounderCreateAgent
 ===================================================
 
+SunFounder Create Agent is a small application, let you run commands right on our online tutorials. 
+Learning programing never been this easy and fun!
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+
+   sunfoundercreateagent
+   quick_user_tutorial
+   faq
diff --git a/docs/source/linux.rst b/docs/source/linux.rst
@@ -0,0 +1,63 @@
+Linux
+===================================
+
+1. Enter the corresponding ReadTheDocs tutorial address 
+in the browser to enter the tutorial page.
+
+.. image:: media/image18.png
+
+
+2. Click \"Disconnected\".
+
+.. image:: media/image19.png
+
+
+3. Please download SunFounderCreateAgent for the first use, 
+and download it by clicking \"Download the Agent\".
+
+.. image:: media/image20.png
+
+
+4. After the download is complete, double-click the 
+SunFounder-Create-Agent-linux-v1.0.0.deb file to install it.
+
+.. image:: media/image21.png
+
+
+Click \"install\" to install.
+
+.. image:: media/image22.png
+
+
+Enter the raspberry username and password, and click \"OK\".
+
+.. image:: media/image23.png
+    :align: center
+
+Waiting for installation.
+
+.. image:: media/image24.png
+    :align: center
+
+The installation is successful when the installation popup disappears!
+
+5. Run SunFounderCreateAgent: Click \"Accessories\" in the Raspberry Pi menu and select Sunfounder
+Create Agent to run the software.
+
+.. image:: media/image25.png
+    :align: center
+
+After running, a Note prompt box will pop up, and a small SunFounderCreateAgent icon will appear in the taskbar.
+
+.. image:: media/image26.png
+    :align: center
+
+.. image:: media/image27.png
+    :align: center
+
+6. Exit SunFounderCreateAgent: Click the small SunFounderCreateAgent icon 
+in the taskbar of the Raspberry Pi and select \"Quit\" to exit.
+
+.. image:: media/image28.png
+    :align: center
+
diff --git a/docs/source/mac.rst b/docs/source/mac.rst
@@ -0,0 +1,53 @@
+Mac
+==============================
+
+1. Enter the corresponding ReadTheDocs tutorial address in the browser to enter 
+the tutorial page (the Safari browser is not currently supported).
+
+.. image:: media/image9.png
+    :align: center
+
+2. Click \"Disconnected\".
+
+.. image:: media/image10.png
+    :align: center
+
+3. Please download SunFounderCreateAgent for the first use, 
+and download it by clicking \"Download the Agent\".
+
+.. image:: media/image11.png
+    :align: center
+
+4. After the download is complete, you can double-click 
+SunFounder-Create-Agent-darwin-v1.0.0.dmg to install it.
+
+.. image:: media/image12.png
+    :align: center
+
+5. Place the SunFounderCreateAgent icon on the Applications icon, that is, 
+add SunFounder Create Agent to Applications.
+
+.. image:: media/image13.png
+    :align: center
+
+6. Run SunFounderCreateAgent: Open Finder, enter the application, and double-click SunFounder
+Create Agent, you can also enter the startup station to run SunFounder Create Agent.
+
+.. image:: media/image14.png
+    :align: center
+
+After the prompt box pops up, select \"Open\".
+
+.. image:: media/image15.png
+    :align: center
+
+The Note prompt box pops up to indicate successful operation!
+
+.. image:: media/image16.png
+    :align: center
+
+7. Exit SunFounder-Create-Agent: Click SunFounder-Create-Agent of the computer task
+A small icon will pop up in the menu bar, click \"Quit\" to exit.
+
+.. image:: media/image17.png
+    :align: center
diff --git a/docs/source/media/image1.png b/docs/source/media/image1.png
diff --git a/docs/source/media/image10.png b/docs/source/media/image10.png
diff --git a/docs/source/media/image11.png b/docs/source/media/image11.png
diff --git a/docs/source/media/image12.png b/docs/source/media/image12.png
diff --git a/docs/source/media/image13.png b/docs/source/media/image13.png
diff --git a/docs/source/media/image14.png b/docs/source/media/image14.png
diff --git a/docs/source/media/image15.png b/docs/source/media/image15.png
diff --git a/docs/source/media/image16.png b/docs/source/media/image16.png
diff --git a/docs/source/media/image17.png b/docs/source/media/image17.png
diff --git a/docs/source/media/image18.png b/docs/source/media/image18.png
diff --git a/docs/source/media/image19.png b/docs/source/media/image19.png
diff --git a/docs/source/media/image2.png b/docs/source/media/image2.png
diff --git a/docs/source/media/image20.png b/docs/source/media/image20.png
diff --git a/docs/source/media/image21.png b/docs/source/media/image21.png
diff --git a/docs/source/media/image22.png b/docs/source/media/image22.png
diff --git a/docs/source/media/image23.png b/docs/source/media/image23.png
diff --git a/docs/source/media/image24.png b/docs/source/media/image24.png
diff --git a/docs/source/media/image25.png b/docs/source/media/image25.png
diff --git a/docs/source/media/image26.png b/docs/source/media/image26.png
diff --git a/docs/source/media/image27.png b/docs/source/media/image27.png
diff --git a/docs/source/media/image28.png b/docs/source/media/image28.png
diff --git a/docs/source/media/image29.png b/docs/source/media/image29.png
diff --git a/docs/source/media/image3.png b/docs/source/media/image3.png
diff --git a/docs/source/media/image30.png b/docs/source/media/image30.png
diff --git a/docs/source/media/image31.png b/docs/source/media/image31.png
diff --git a/docs/source/media/image32.png b/docs/source/media/image32.png
diff --git a/docs/source/media/image33.png b/docs/source/media/image33.png
diff --git a/docs/source/media/image34.png b/docs/source/media/image34.png
diff --git a/docs/source/media/image35.png b/docs/source/media/image35.png
diff --git a/docs/source/media/image36.png b/docs/source/media/image36.png
diff --git a/docs/source/media/image37.png b/docs/source/media/image37.png
diff --git a/docs/source/media/image38.jpg b/docs/source/media/image38.jpg
diff --git a/docs/source/media/image38.png b/docs/source/media/image38.png
diff --git a/docs/source/media/image39.png b/docs/source/media/image39.png
diff --git a/docs/source/media/image4.png b/docs/source/media/image4.png
diff --git a/docs/source/media/image5.png b/docs/source/media/image5.png
diff --git a/docs/source/media/image6.png b/docs/source/media/image6.png
diff --git a/docs/source/media/image7.png b/docs/source/media/image7.png
diff --git a/docs/source/media/image8.png b/docs/source/media/image8.png
diff --git a/docs/source/media/image85.png b/docs/source/media/image85.png
diff --git a/docs/source/media/image9.png b/docs/source/media/image9.png
diff --git a/docs/source/quick_user_tutorial.rst b/docs/source/quick_user_tutorial.rst
@@ -0,0 +1,53 @@
+Quick User Tutorial
+============================
+
+Connect Raspberry Pi
+------------------------
+
+1. SunFounderCreateAgent connects to Raspberry Pi: Open the ReadTheDoc tutorial webpage, 
+click \"I have open the Agent\".
+
+.. image:: media/image31.png
+    :align: center
+
+2. Click \"OK\".
+
+.. image:: media/image32.png
+    :align: center
+
+3. Enter the Raspberry Pi IP, username and password on the Connect to Raspberry Pi interface, 
+and click \"connect\"(please enter \"127.0.0.1\" for the Raspberry Pi system connection IP).
+
+.. image:: media/image33.png
+    :align: center
+
+4. Connection succeeded
+
+.. image:: media/image34.png
+    :align: center
+
+Use and Interface Introduction
+------------------------------------
+
+1. After the connection is successful, the IP of the currently connected Raspberry Pi will be 
+displayed in the upper right corner of the tutorial bar on the ReadTheDoc page, 
+and the command bar will be displayed on the right side of the page. Click the IP again, 
+and \"Disconnected\" will be displayed. 
+You can disconnect from the Raspberry Pi by clicking \"Disconnected\".
+
+.. image:: media/image35.png
+    :align: center
+
+
+2. **Run:** Click the \"Run\" button in the code box, and the code will be executed in the command box on the right.
+
+  **Reset:** to reset the code box code.
+
+  **Copy:** to copy the code box code.
+
+  **Stop:** to stop the code box code.
+
+
+.. image:: media/image38.png
+    :align: center
+
diff --git a/docs/source/sunfoundercreateagent.rst b/docs/source/sunfoundercreateagent.rst
@@ -0,0 +1,12 @@
+SunFounderCreateAgent Installation Tutorial
+===============================================
+
+SunFounder Create Agent is a small application, let you run commands right on our online tutorials. 
+Learning programing never been this easy and fun!
+
+.. toctree::
+    :maxdepth: 1
+
+    windows
+    mac
+    linux
diff --git a/docs/source/windows.rst b/docs/source/windows.rst
@@ -0,0 +1,49 @@
+Windows 
+=================================
+
+1. Enter the corresponding ReadTheDocs tutorial address 
+in the browser to enter the tutorial page.
+
+.. image:: media/image1.png
+    :align: center
+
+2. Click \"Disconnected\".
+
+.. image:: media/image2.png
+    :align: center
+
+3. Please download SunFounderCreateAgent for the first use, 
+and download it by clicking \"Download the Agent\".
+
+.. image:: media/image3.png
+    :align: center
+
+4. Open the downloaded SunFounderCreateAgent.exe file to install it.
+
+5. Click \"Install for me only\" to enter the selection of installation location.
+
+.. image:: media/image4.png
+    :align: center
+
+6. The installation location can choose to install the default location,
+or you can choose the directory you want to install.
+After the selection is complete, click \"Next\".
+
+.. image:: media/image5.png
+    :align: center
+
+7. Choose to create a desktop shortcut and then click \"Next\".
+
+.. image:: media/image6.png
+    :align: center
+
+8. Click \"Install\" to install.
+
+.. image:: media/image7.png
+    :align: center
+
+9. After the installation is complete, 
+you can double-click the desktop icon to run SunFounderCreateAgent.
+
+.. image:: media/image8.png
+    :align: center