binary-husky commited on
Commit
a3d179c
1 Parent(s): fda48fd

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -21
README.md CHANGED
@@ -84,45 +84,42 @@ chat分析报告生成 | [实验性功能] 运行后自动生成总结汇报
84
 
85
  ## 直接运行 (Windows, Linux or MacOS)
86
 
87
- 下载项目
88
-
89
  ```sh
90
  git clone https://github.com/binary-husky/chatgpt_academic.git
91
  cd chatgpt_academic
92
  ```
93
 
 
94
  我们建议将`config.py`复制为`config_private.py`并将后者用作个性化配置文件以避免`config.py`中的变更影响你的使用或不小心将包含你的OpenAI API KEY的`config.py`提交至本项目。
95
 
96
- ```sh
97
- cp config.py config_private.py
98
- ```
99
-
100
- 在`config_private.py`中,配置 海外Proxy 和 OpenAI API KEY
101
  ```
102
- 1. 如果你在国内,需要设置海外代理才能够使用 OpenAI API,你可以通过 config.py 文件来进行设置。
103
  2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
 
104
  ```
105
- 安装依赖
106
 
 
107
  ```sh
108
- python -m pip install -r requirements.txt
109
- ```
110
 
111
- 或者,如果你希望使用`conda`
 
 
 
112
 
113
- ```sh
114
- conda create -n gptac 'gradio>=3.23' requests
115
- conda activate gptac
116
- python3 -m pip install mdtex2html
117
  ```
118
 
119
- 运行
120
-
121
  ```sh
122
  python main.py
123
  ```
124
 
125
- 测试实验性功能
126
  ```
127
  - 测试C++项目头文件分析
128
  input区域 输入 `./crazy_functions/test_project/cpp/libJPG` , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)"
@@ -136,8 +133,6 @@ python main.py
136
  点击 "[实验] 实验功能函数模板"
137
  ```
138
 
139
- 与代理网络有关的issue(网络超时、代理不起作用)汇总到 https://github.com/binary-husky/chatgpt_academic/issues/1
140
-
141
  ## 使用docker (Linux)
142
 
143
  ``` sh
 
84
 
85
  ## 直接运行 (Windows, Linux or MacOS)
86
 
87
+ ### 1. 下载项目
 
88
  ```sh
89
  git clone https://github.com/binary-husky/chatgpt_academic.git
90
  cd chatgpt_academic
91
  ```
92
 
93
+ ### 2. 配置API_KEY和代理设置
94
  我们建议将`config.py`复制为`config_private.py`并将后者用作个性化配置文件以避免`config.py`中的变更影响你的使用或不小心将包含你的OpenAI API KEY的`config.py`提交至本项目。
95
 
96
+ 在`config.py`或`config_private.py`中,配置 海外Proxy 和 OpenAI API KEY,说明如下
 
 
 
 
97
  ```
98
+ 1. 如果你在国内,需要设置海外代理才能够顺利使用 OpenAI API,设置方法请仔细阅读config.py
99
  2. 配置 OpenAI API KEY。你需要在 OpenAI 官网上注册并获取 API KEY。一旦你拿到了 API KEY,在 config.py 文件里配置好即可。
100
+ 3. 与代理网络有关的issue(网络超时、代理不起作用)汇总到 https://github.com/binary-husky/chatgpt_academic/issues/1
101
  ```
 
102
 
103
+ ### 3. 安装依赖
104
  ```sh
105
+ # (选择一)推荐
106
+ python -m pip install -r requirements.txt
107
 
108
+ # (选择二)如果您使用anaconda,步骤也是类似的:
109
+ # (选择二.1)conda create -n gptac_venv python=3.11
110
+ # (选择二.2)conda activate gptac_venv
111
+ # (选择二.3)python -m pip install -r requirements.txt
112
 
113
+ # 备注:使用官方pip源或者阿里pip源,其他pip源(如清华pip)有可能出问题,临时换源方法:
114
+ # python -m pip install -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple/
 
 
115
  ```
116
 
117
+ ### 4. 运行
 
118
  ```sh
119
  python main.py
120
  ```
121
 
122
+ ### 5. 测试实验性功能
123
  ```
124
  - 测试C++项目头文件分析
125
  input区域 输入 `./crazy_functions/test_project/cpp/libJPG` , 然后点击 "[实验] 解析整个C++项目(input输入项目根路径)"
 
133
  点击 "[实验] 实验功能函数模板"
134
  ```
135
 
 
 
136
  ## 使用docker (Linux)
137
 
138
  ``` sh