-
Notifications
You must be signed in to change notification settings - Fork 167
/
config.toml
348 lines (262 loc) · 11.2 KB
/
config.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
# Default API Settings
[api]
rate_limit = 10
system_message = "You're a brilliant Tech Lead and Staff Software Engineer with a passion for open-source projects."
# File Resources
[files]
ignore_list = "ignore_list.toml"
languages = "languages.toml"
parsers = "parsers.toml"
prompts = "prompts.toml"
tool_config = "tool_config.toml"
tooling = "tooling.toml"
shieldsio_icons = "shieldsio_icons.json"
skill_icons = "skill_icons.json"
# Git Repository Settings
[git]
repository = "https://github.com/eli64s/readme-ai"
# Language Model API Settings
[llm]
api = "openai"
base_url = "https://api.openai.com/v1/engines/"
context_window = 3900
encoder = "cl100k_base"
host_name = "https://api.openai.com/"
localhost = "http://localhost:11434/"
model = "gpt-3.5-turbo"
path = "v1/chat/completions"
temperature = 0.1
tokens = 699
top_p = 0.9
# Logging Configuration
[log]
log_level = "info"
indent = 2
pad_event = 20
use_json = true
# [badges]
# badges_tech_stack = """
# \t<em>Built with the tools and technologies:</em>
# </p>
# <p align="{align}">
# \t{badges_tech_stack}
# """
# github_stats = """
# 
# 
# 
# 
# 
# 
# """
# shieldsio_icons = """
# <img src="https://img.shields.io/{host}/license/{full_name}?style={badge_style}&logo=opensourceinitiative&logoColor=white&color={badge_color}" alt="license">
# \t<img src="https://img.shields.io/{host}/last-commit/{full_name}?style={badge_style}&logo=git&logoColor=white&color={badge_color}" alt="last-commit">
# \t<img src="https://img.shields.io/{host}/languages/top/{full_name}?style={badge_style}&color={badge_color}" alt="repo-top-language">
# \t<img src="https://img.shields.io/{host}/languages/count/{full_name}?style={badge_style}&color={badge_color}" alt="repo-language-count">
# """
# skill_icons = """<a href="https://skillicons.dev">\n\t\t<img src="{}">\n\t</a>"""
# Markdown Configuration
[md]
badges_tech_stack_text = "Built with the tools and technologies:"
badges_tech_stack = """{badges_tech_stack}"""
github_stats = """
"""
shieldsio_icons = """
<img src="https://img.shields.io/{host}/license/{full_name}?style={badge_style}&logo=opensourceinitiative&logoColor=white&color={badge_color}" alt="license">
\t<img src="https://img.shields.io/{host}/last-commit/{full_name}?style={badge_style}&logo=git&logoColor=white&color={badge_color}" alt="last-commit">
\t<img src="https://img.shields.io/{host}/languages/top/{full_name}?style={badge_style}&color={badge_color}" alt="repo-top-language">
\t<img src="https://img.shields.io/{host}/languages/count/{full_name}?style={badge_style}&color={badge_color}" alt="repo-language-count">
"""
skill_icons = """<a href="https://skillicons.dev">\n\t\t<img src="{}">\n\t</a>"""
overview = """
## 📍 Overview
{0}
---
"""
features = """
## 👾 Features
{0}
---
"""
tree = """
## 📁 Project Structure
```sh
{0}
```
"""
project_index = "\n### 📂 Project Index"
quickstart = """
---
## 🚀 Getting Started
### ☑️ Prerequisites
Prerequisites to run the project:
- **Programming Language:** {programming_language} `{programming_language_version}`\n{system_requirements}
### ⚙️ Installation
##### Build from Source
1. Clone the {repo_name} repository:
```sh
❯ git clone {repo_url}
```
2. Navigate to the project directory:
```sh
❯ cd {repo_name}
```
3. Install the project dependencies:
{install_commands}
### 🤖 Usage
Run {repo_name} using the following command:
{usage_commands}
### 🧪 Testing
Execute the test suite using the following command:
{test_commands}
---
"""
# -- Contributing Section -----------------------------------------------------------
contribute = """---\n## 📌 Project Roadmap\n
- [X] **`Task 1`**: <strike>Implement feature one.</strike>
- [ ] **`Task 2`**: Implement feature two.
- [ ] **`Task 3`**: Implement feature three.
---
## 🔰 Contributing
- **💬 [Join the Discussions](https://{host_domain}/{full_name}/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://{host_domain}/{full_name}/issues)**: Submit bugs found or log feature requests for the `{repo_name}` project.
- **💡 [Submit Pull Requests](https://{host_domain}/{full_name}/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
<details closed>
<summary>Contributing Guidelines</summary>
1. **Fork the Repository**: Start by forking the project repository to your {host} account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone {repo_url}
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Your Changes**: Develop and test your changes locally.
5. **Commit Your Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to {host}**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
</details>
<details closed>
<summary>Contributor Graph</summary>
<br>
<p align="left">
<a href="https://{host_domain}{{/{full_name}/}}graphs/contributors">
<img src="https://contrib.rocks/image?repo={full_name}">
</a>
</p>
</details>
---
## 🎗 License
This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file.
---
## 🙌 Acknowledgments
- List any resources, contributors, inspiration, etc. here.
---
"""
contributing = """
## 🔰 Contributing
- **💬 [Join the Discussions](https://{host_domain}/{full_name}/discussions)**: Share your insights, provide feedback, or ask questions.
- **🐛 [Report Issues](https://{host_domain}/{full_name}/issues)**: Submit bugs found or log feature requests for the `{repo_name}` project.
- **💡 [Submit Pull Requests](https://{host_domain}/{full_name}/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs.
---
"""
contributing_guidelines = """
<details open><summary>Contributing Guidelines</summary><br>
1. **Fork the Repository**: Start by forking the project repository to your {host} account.
2. **Clone Locally**: Clone the forked repository to your local machine using a git client.
```sh
git clone {repo_url}
```
3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name.
```sh
git checkout -b new-feature-x
```
4. **Make Changes**: Develop and test your changes locally.
5. **Commit Changes**: Commit with a clear message describing your updates.
```sh
git commit -m 'Implemented new feature x.'
```
6. **Push to {host}**: Push the changes to your forked repository.
```sh
git push origin new-feature-x
```
7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
</details>
"""
contributor_graph = """
<p align="{align}">
<a href="https://{host_domain}{/{full_name}/}graphs/contributors">
<img src="https://contrib.rocks/image?repo={full_name}" />
</a>
</p>
"""
# -- Contact Section -----------------------------------------------------------
contact = """
<p align="center">
<sub>
For {name} issues and feature requests please visit the <a href="https://{host_domain}/{full_name}/issues">issues</a> page, or feel free to start a <a href="https://github.com/eli64s/readme-ai/discussions">discussion!</a>
</sub><br>
</p>
<div align="center">
<a href="https://github.com/eli64s"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="eli64s GitHub"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://www.linkedin.com/company/ultralytics/"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png" width="3%" alt="Ultralytics LinkedIn"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
<a href="https://twitter.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png" width="3%" alt="Ultralytics Twitter"></a>
<img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="space">
</div>
"""
# -- API Documentation Section -----------------------------------------------------------
api_docs = """
### API Documentation
The project API documentation is available at: [API Documentation]({api_url}).
---
"""
env_variables = """
### Environment Variables
To run this project, you will need to add the following environment variables to your environment:
{env_variables}
---
"""
cli_docs = """
### Command-Line Interface
The project supports the following command-line interface options:
```sh
❯ {cli_command}
```
---
"""
test_framework = """
### 🧪 Testing
This project uses [{test_framework}]() for testing. Execute the test suite using the following command:
```sh
❯ {test_command}
```
---
"""
signature = """
<p align="center">
<sub>Generated by <a href="https://github.com/eli64s/readme-ai">readme-ai</a></sub>
</p>
<p align="center">
<a href="https://github.com/eli64s/readme-ai">
<img src="https://img.shields.io/badge/readme--ai-DDDDDD?style=flat&logo=ReadMe&logoColor=blueviolet" alt="readme-ai">
</a>
</p>
"""