@@ -18,7 +18,7 @@ This Python script efficiently generates customized prompts using a template and
18
18
19
19
## ** Usage**
20
20
21
- ** 1. Prepare your files:**
21
+ ** 1. Understand your files (Not Necessary Already Done.) :**
22
22
23
23
* ** key-values.csv:**
24
24
* Create a CSV file with columns representing the keys to be replaced in your template.
@@ -31,10 +31,10 @@ This Python script efficiently generates customized prompts using a template and
31
31
** 2. Run the script:**
32
32
33
33
``` bash
34
- python main.py [--description-mode ]
34
+ python main.py [-d ]
35
35
```
36
36
37
- * ** Optional:** Use ` --description-mode ` to exclude titles and focus on city names in your prompts.
37
+ * ** Optional:** Use ` -d ` to exclude titles and focus on city names in your prompts.
38
38
39
39
## ** Explanation**
40
40
@@ -46,13 +46,18 @@ This Python script efficiently generates customized prompts using a template and
46
46
Explore the Charm of, Paris, France
47
47
A Journey Through, Tokyo, Japan
48
48
```
49
+ ![ keyvalue.csv Example] (/assets/keyvalues.csv_example.png
50
+
49
51
50
52
* ** Prompt Template ('prompt.txt')**
51
53
Use ` **/key/** ` to mark replacement points. Example:
52
54
53
55
```
54
56
Write a travel blog titled "**/title/**" about the captivating city of **/city/**, **/country/**.
55
57
```
58
+ ![ prompt.txt Example] ( /assets/prompt.txt_example.png )
59
+
60
+ ![ key_example1] ( /assets/key_example1.png ) ![ key_example2] ( /assets/key_example2.png )
56
61
57
62
* ** Output**
58
63
Generated prompts are saved as individual .txt files within a specified folder.
@@ -63,24 +68,8 @@ This Python script efficiently generates customized prompts using a template and
63
68
## ** Terminology**
64
69
65
70
* ** key:** A column header in 'key-values.csv', used as an identifier in the template.
66
- * ` **/key/** ` : Indicates a placeholder in the template, to be substituted with values from 'key-values.csv'.
67
-
68
- ## ** Contributing**
69
-
70
- Feel free to submit bug reports, feature requests, and pull requests!
71
-
72
- ## ** License**
73
-
74
- [ Include the appropriate license for your project]
75
-
76
- ## ** Key Improvements:**
77
-
78
- * ** Concise and Clear Title:** Emphasizes the tool's main functionality.
79
- * ** Structured Installation:** Guides users with prerequisites and step-by-step instructions.
80
- * ** Detailed Usage:** Explains file preparation and script execution with clarifying examples.
81
- * ** Enhanced Explanation:** Provides visuals to demonstrate the CSV structure and prompt template format.
82
- * ** Consistent Terminology:** Maintains a glossary for easy reference.
83
- * ** Inviting Contributions and Licensing:** Encourages community engagement and clarifies usage rights.
71
+ * ` **/key/** ` : Indicates a placeholder in the template, to be substituted with values from 'key-values.csv'.
84
72
85
73
86
74
## ** Known Exceptions and Error:**
75
+ ** Nill**
0 commit comments