anpigon commited on
Commit
d42d07f
1 Parent(s): efc4f5e

docs(README.md): add installation and execution instructions for the project

Browse files

Add installation instructions to the README.md file to guide users on how to set up the project:
- Clone the repository using `git clone git@hf.co:spaces/anpigon/talktosayno`
- Navigate to the project directory using `cd talktosayno`
- Install the project dependencies using `pip install -r requirements.txt`

Add execution instructions to the README.md file to guide users on how to run the project:
- Create a `docs` folder and place the PDF files to be processed inside it
- Run the command `python ingest.py` to process the documents

Also, fix a typo in the execution command:
- Change `python app.pyt` to `python app.py` for correct execution.

Files changed (1) hide show
  1. README.md +19 -0
README.md CHANGED
@@ -11,4 +11,23 @@ license: openrail
11
  duplicated_from: JUNGU/talktosayno
12
  ---
13
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
14
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
11
  duplicated_from: JUNGU/talktosayno
12
  ---
13
 
14
+ ## 설치하기
15
+ ```sh
16
+ git clone git@hf.co:spaces/anpigon/talktosayno
17
+ cd talktosayno
18
+ pip install -r requirements.txt
19
+ ```
20
+
21
+ ## PDF 학습하기
22
+ 1. `docs` 폴더를 생성하고, 학습할 PDF 파일을 `docs` 폴더에 넣습니다.
23
+ 2. 그 다음 `python ingest.py` 명령을 실행하여 문서를 학습시킵니다.
24
+
25
+ ## 실행하기
26
+ ```py
27
+ python app.pyt
28
+ ```
29
+ <br>
30
+
31
+ ---
32
+
33
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference