Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2.06 KB

README.en.md

File metadata and controls

51 lines (30 loc) · 2.06 KB

quecpython‑docs

QuecPython Documentation Repository. This repository stores the source files for both Chinese and English documentation, serving as the source‑code repository for QuecPython developers to view and contribute to documents.

中文 | English

📖 Introduction

QuecPython is a Python secondary‑development platform developed by Quectel Wireless Solutions, ported based on MicroPython and targeted at cellular IoT modules. It is compatible with Python 3 syntax and supports dynamic script loading, lowering the development barrier for IoT embedded development.

This repository holds the full set of QuecPython documentation sources, including separate Chinese and English document sources. Local build and online preview are supported, and community contributions for document revision and supplementation are welcome.

📂 Repository Directory Structure

quecpython‑docs
├── cn/                # Entry point for Chinese documentation
├── en/                # Entry point for English documentation
├── LICENSE            # MIT License
├── README.md
└── README.en.md

📝 Document Usage Instructions

  1. Source files for Chinese documents are stored in the cn/ folder; source files for English documents are stored in the en/ folder.

  2. All documents are written in Markdown format.

  3. The README.md in each sub‑directory acts as the entry page for that chapter.

👨‍💻 Contribution Guidelines

Issues and Pull Requests are welcome to improve the documents. Contribution steps:

  1. Fork this repository

  2. Create a new branch. Recommended branch naming convention: feat/xxx / fix/xxx

  3. Modify the corresponding document source files and verify normal rendering via local preview

  4. Make commits and push them to your forked repository

  5. Submit a Pull Request and wait for review and merge

Before submitting a PR, please check Markdown links, image paths, and consistency of Chinese‑English terminology.

📄 License

MIT License