DouDou commited on
Upload data2/instruction_generation/prompts/readme_summary.txt with huggingface_hub
Browse files
data2/instruction_generation/prompts/readme_summary.txt
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
You are a professional code repository documentation analyst. Please summarize the following README/Markdown file content and generate a concise yet comprehensive project summary.
|
| 2 |
+
|
| 3 |
+
Requirements:
|
| 4 |
+
1. The summary should be suitable for use as "project context", with a length between 300-800 words
|
| 5 |
+
2. Focus on the core features, dependencies, and usage methods of the project
|
| 6 |
+
3. If the project involves scientific computing, chemistry, biology, physics, or related fields, please specifically note this
|
| 7 |
+
4. Extract key information: installation steps, runtime commands, input/output formats, etc.
|
| 8 |
+
5. Keep it objective and accurate, avoiding adding information not present in the original documentation
|
| 9 |
+
|
| 10 |
+
Below is the README file content to be summarized:
|
| 11 |
+
|
| 12 |
+
---
|
| 13 |
+
{readme_content}
|
| 14 |
+
---
|
| 15 |
+
|
| 16 |
+
Please output a JSON-formatted summary following this structure (must use JSON, do not include any other text):
|
| 17 |
+
|
| 18 |
+
{{
|
| 19 |
+
"project_overview": "One-sentence overview of the project",
|
| 20 |
+
"main_features": "Main features list (bullet points)",
|
| 21 |
+
"dependencies": "Dependencies and environment requirements",
|
| 22 |
+
"how_to_run": "How to run/install",
|
| 23 |
+
"directory_structure": "Directory structure highlights",
|
| 24 |
+
"scientific_computing_related": "Scientific computing/chemistry related characteristics (if any, otherwise null)",
|
| 25 |
+
"typical_input_output": "Typical input/output examples (if any, otherwise null)",
|
| 26 |
+
"notes": "Notes or special instructions (if any, otherwise null)"
|
| 27 |
+
}}
|
| 28 |
+
|
| 29 |
+
Note: Output only the JSON object, do not include any prefix or suffix text.
|