# code2doc

**Repository Path**: jixiege/code2doc

## Basic Information

- **Project Name**: code2doc
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-22
- **Last Updated**: 2024-08-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI 软件说明文档生成

> 通过阅读代码，自动生成文档

- 作者：欧阳鹏
- 开发日期：2023 年 4 月 20 日

## 使用方法

1. 将 `.env.example` 复制到 `.env`，填写 OpenAI 的 API KEY
2. 将源代码下载到 `code` 文件夹中（文件结构无所谓，程序自动遍历读取）
3. 将事先准备的文档大纲，放入 `tasks` 文件中（已自带，可修改），一行一个任务
4. 运行 `main.py` 等待文档编写完成