change the config files

sunfounder · Nov 27, 2023 · 7bacb11 · 7bacb11
1 parent 568d06c
commit 7bacb11
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# Build all formats
+formats: all
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+   install:
+   - requirements: docs/requirements.txt
diff --git a/README.md b/README.md
@@ -1 +1,58 @@
-# 7-diy-touch-screen
+# SunFounder 3in1 Kit
+This repository is for SunFounder TS-7 7-diy-touch-screen. you can buy it on [our website](https://www.sunfounder.com/), or search sunfounder in Amazon.
+
+Quick Links:
+
+ * [About this kit](#about_this_kit)
+ * [Update](#update)
+ * [Trouble Shootings](#trouble)
+ * [About SunFounder](#about_sunfounder)
+ * [License](#license)
+ * [Contact us](#contact_us)
+
+<a id="about_this_kit"></a>
+## About this kit:
+
+TS-7 7-inch touch screen supports Raspbian/Win7/Win8/Win10(Plug and play), Android/Linux (need to be configured first). 
+Equipped with Micro USB and HDMI port support, the screen can be connected to the device via HDMI interface and be powered via USB. Achieving touch function powered by USB doesn’t need power cord or drive-free.
+
+
+
+<a id="update"></a>
+## Update:
+2023-11-24:
+- Add tips about installing the older version of the Bullseye system.
+
+<a id="trouble"></a>
+## Trouble Shootings:
+
+<a id="about_sunfounder"></a>
+## About SunFounder
+SunFounder is a company focused on STEAM education with products like open source robots, development boards, STEAM kit, modules, tools and other smart devices distributed globally. In SunFounder, we strive to help elementary and middle school students as well as hobbyists, through STEAM education, strengthen their hands-on practices and problem-solving abilities. In this way, we hope to disseminate knowledge and provide skill training in a full-of-joy way, thus fostering your interest in programming and making, and exposing you to a fascinating world of science and engineering. To embrace the future of artificial intelligence, it is urgent and meaningful to learn abundant STEAM knowledge.
+
+<a id="license"></a>
+## License
+This is the code for SunFounder TS-7 7-diy-touch-screen.
+This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied wa rranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+TS-7 7-diy-touch-screen comes with ABSOLUTELY NO WARRANTY; for details run ./show w. This is free software, and you are welcome to redistribute it under certain conditions; run ./show c for details.
+
+SunFounder, Inc., hereby disclaims all copyright interest in the program 'TS-7 7-diy-touch-screen' (which makes passes at compilers).
+
+Mike Huang, 21 August 2015
+
+Mike Huang, Chief Executive Officer
+
+Email: service@sunfounder.com
+
+<a id="contact_us"></a>
+## Contact us:
+website:
+    www.sunfounder.com
+
+E-mail:
+    service@sunfounder.com
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,9 +17,10 @@
 
 # -- Project information -----------------------------------------------------
 import sphinx_rtd_theme
+import time  ###
 
 project = '7-inch DIY Touch Screen'
-copyright = '2021, sunfounder'
+copyright = f'{time.localtime().tm_year}, SunFounder'  ###
 author = 'www.sunfounder.com'